docs._layouts.swagger.html Maven / Gradle / Ivy
---
layout: page
---
{{ content }}
{% if page.data %}
{% assign swagger = site.data[page.data] %}
{% else %}
{% assign swagger = page %}
{% endif %}
{% for route in swagger.paths %}
{{ route[0] }}
{% for method in route[1] %}
{{ method[0] | upcase }}
{{ method[1].summary }}
{% if method[1].parameters %}
{{ method[1].description | markdownify }}
Parameters
Name
In
Description
Type
{% for parameter in method[1].parameters %}
{% if parameter.name == null %}
{% assign ref = parameter['$ref'] | split:"/" | last %}
{% if swagger.parameters[ref].required %}
{% endif %}
{{ swagger.parameters[ref].name }}
{% if swagger.parameters[ref].required %}
{% endif %}
{{ swagger.parameters[ref].in }}
{{ swagger.parameters[ref].description | markdownify }}
{% if swagger.parameters[ref].type %}
{{ swagger.parameters[ref].type | capitalize }}
{% if swagger.parameters[ref].items %}
of {{ swagger.parameters[ref].items.type | capitalize }}
{% endif %}
{% else %}
String
{% endif %}
{% else %}
{% if parameter.required %}
{% endif %}
{{ parameter.name }}
{% if parameter.required %}
{% endif %}
{{ parameter.in }}
{{ parameter.description }}
{% if parameter.type %}
{{ parameter.type | capitalize }}
{% if parameter.items %}
of {{ parameter.items.type | capitalize }}
{% endif %}
{% else %}
String
{% endif %}
{% endif %}
{% endfor %}
{% endif %}
{% if method[1].responses %}
Responses
{% for response in method[1].responses %}
{{ response[0] }}
{{ response[1].description }}
{% for content_type in swagger.produces %}
{% if response[1].examples[content_type] %}
{% assign example = response[1].examples[content_type] %}
{% if content_type contains 'json' %}
{% highlight json %}{{ example }}{% endhighlight %}
{% elsif content_type contains 'xml' %}
{% highlight xml %}{{ example }}{% endhighlight %}
{% else %}
{% highlight http %}{{ example }}{% endhighlight %}
{% endif %}
{% endif %}
{% endfor %}
{% endfor %}
{% endif %}
{% endfor %}
{% endfor %}