{{ yaml.name }}
{{ api.name }}
{{ api.method | upcase }}
{{ site.api_baseurl | escape }}{{ yaml.baseurl | escape }}{{ api.url | escape }}
Headers
Field | Type | Description |
---|---|---|
{{ param.name }} {% if param.is_required %}required {% else %}optional {% endif %} |
{{ param.type }} |
{{ param.description | markdownify }} |
Path Parameters
Field | Type | Description |
---|---|---|
{{ param.name }} {% if param.is_required %}required {% else %}optional {% endif %} |
{{ param.type }} |
{{ param.description | markdownify }} |
Query Parameters
Field | Type | Description |
---|---|---|
{{ param.name }} {% if param.is_required %}required {% else %}optional {% endif %} |
{{ param.type }} |
{{ param.description | markdownify }} |
Body Parameters
Field | Type | Description |
---|---|---|
{{ param.name }} {% if param.is_required %}required {% else %}optional {% endif %} |
{{ param.type }} |
{{ param.description | markdownify }} |
Success
{{ item.status_code }} {% if item.status_code == 200 %} : Success {% endif %}
{% if item.description %}Fail
{{ item.status_code }} {% if item.status_code == 400 %} : Bad Request {% elsif item.status_code == 401 %} : Unauthorized {% elsif item.status_code == 403 %} : Forbidden {% elsif item.status_code == 404 %} : Not Found {% endif %}
{% if item.description %}