#{{#info}}{{title}} ## {{join schemes " | "}}://{{host}}{{basePath}} {{description}} {{#contact}} [**Contact the developer**](mailto:{{email}}) {{/contact}} **Version** {{version}} {{#license}}[**{{name}}**]({{url}}){{/license}} {{/info}} {{#if consumes}}**Consumes:** {{join consumes ", "}}{{/if}} {{#if produces}}**Produces:** {{join produces ", "}}{{/if}} {{#if securityDefinitions}} # Security Definitions {{/if}} {{> security}} # APIs {{#each paths}} ## {{@key}} {{#this}} {{#get}} ### GET {{> operation}} {{/get}} {{#put}} ### PUT {{> operation}} {{/put}} {{#post}} ### POST {{> operation}} {{/post}} {{#delete}} ### DELETE {{> operation}} {{/delete}} {{#option}} ### OPTION {{> operation}} {{/option}} {{#patch}} ### PATCH {{> operation}} {{/patch}} {{#head}} ### HEAD {{> operation}} {{/head}} {{/this}} {{/each}} # Definitions {{#each definitions}} ## {{@key}} {{#each this.properties}} {{/each}}
name type required description example
{{@key}} {{#ifeq type "array"}} {{#items.$ref}} {{type}}[{{basename items.$ref}}] {{/items.$ref}} {{^items.$ref}}{{type}}[{{items.type}}]{{/items.$ref}} {{else}} {{#$ref}}{{basename $ref}}{{/$ref}} {{^$ref}}{{type}}{{#format}} ({{format}}){{/format}}{{/$ref}} {{/ifeq}} {{#required}}required{{/required}}{{^required}}optional{{/required}} {{#description}}{{{description}}}{{/description}}{{^description}}-{{/description}} {{example}}
{{/each}}