htmlDocs.index.mustache Maven / Gradle / Ivy

Go to download

  
    
    API Reference
  
  
  {{{appName}}}
    {{{appDescription}}} for {{partner}}
    {{#infoUrl}}More information: {{{infoUrl}}}{{/infoUrl}}
    {{#infoEmail}}Contact Info: {{{infoEmail}}}{{/infoEmail}}
    {{#version}}Version: {{{version}}}{{/version}}
    {{{licenseInfo}}}
    {{{licenseUrl}}}
  Access
  Customize this message as you see fit!
  Methods
  {{#apiInfo}}
  {{#apis}}
  {{#operations}}{{#operation}}
  
    {{httpMethod}}: {{path}}
     {{#tags}}{{this}}{{/tags}}
    {{nickname}} {{summary}}
    {{notes}}

    Parameters
    
      {{#allParams}}{{>queryParam}}{{>pathParam}}{{>bodyParam}}{{>headerParam}}{{>formParam}}
      {{/allParams}}
    
  
    Return type

    {{{returnType}}}

    {{#examples}}
    Example data
    Content-Type: {{{contentType}}}
    {{example}}
    {{/examples}}
  
 
  
  {{/operation}}{{/operations}}
  {{/apis}}{{/apiInfo}}

  Models
  {{#models}}
  {{#model}}
  
    {{classname}}
    
      {{#vars}}{{name}} {{#isNotRequired}}(optional){{/isNotRequired}}
{{datatype}} {{description}}
      {{/vars}}
    
  
  
  {{/model}}
  {{/models}}