htmlDocs.index.mustache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-codegen Show documentation
There is a newer version: 3.0.0-rc1


  
    {{{appName}}}
    
  
  
  {{{appName}}}
    {{{appDescription}}}
    {{#infoUrl}}More information: {{{infoUrl}}}{{/infoUrl}}
    {{#infoEmail}}Contact Info: {{{infoEmail}}}{{/infoEmail}}
    {{#version}}Version: {{{version}}}{{/version}}
    {{#basePathWithoutHost}}BasePath:{{basePathWithoutHost}}{{/basePathWithoutHost}}
    {{{licenseInfo}}}
    {{{licenseUrl}}}
  Access
  {{#hasAuthMethods}}
    
    {{#authMethods}}
      {{#isBasic}}HTTP Basic Authentication{{/isBasic}}{{#isOAuth}}OAuth AuthorizationUrl:{{authorizationUrl}}TokenUrl:{{tokenUrl}}{{/isOAuth}}{{#isApiKey}}APIKey KeyParamName:{{keyParamName}} KeyInQuery:{{isKeyInQuery}} KeyInHeader:{{isKeyInHeader}}{{/isApiKey}}
    {{/authMethods}}
    
  {{/hasAuthMethods}}

  Methods
  [ Jump to Models ]

  {{! for the tables of content, I cheat and don't use CSS styles.... }}
  Table of Contents 
  {{access}}
  {{#apiInfo}}
  {{#apis}}
  {{#operations}}
  {{baseName}}
  
  {{#operation}}
  {{httpMethod}} {{path}}
  {{/operation}}
  
  {{/operations}}
  {{/apis}}
  {{/apiInfo}}

  {{#apiInfo}}
  {{#apis}}
  {{#operations}}
  {{baseName}}
  {{#operation}}
  
    
    Up
    {{httpMethod}} {{path}}
    {{summary}} ({{nickname}})
    {{! notes is operation.description. So why rename it and make it super confusing???? }}
    {{notes}}

    {{#hasPathParams}}
    Path parameters
    
      {{#pathParams}}{{>pathParam}}{{/pathParams}}
    
  
    {{/hasPathParams}}

    {{#hasConsumes}}
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    
    {{#consumes}}
      {{{mediaType}}}
    {{/consumes}}
    
    {{/hasConsumes}}

    {{#hasBodyParam}}
    Request body
    
      {{#bodyParams}}{{>bodyParam}}{{/bodyParams}}
    
  
    {{/hasBodyParam}}

    {{#hasHeaderParams}}
    Request headers
    
      {{#headerParams}}{{>headerParam}}{{/headerParams}}
    
  
    {{/hasHeaderParams}}

    {{#hasQueryParams}}
    Query parameters
    
      {{#queryParams}}{{>queryParam}}{{/queryParams}}
    
  
    {{/hasQueryParams}}

    {{#hasFormParams}}
    Form parameters
    
      {{#formParams}}{{>formParam}}{{/formParams}}
    
  
    {{/hasFormParams}}

    {{#returnType}}
    Return type
    
      {{#hasReference}}{{^returnSimpleType}}{{returnContainer}}[{{/returnSimpleType}}{{returnBaseType}}{{^returnSimpleType}}]{{/returnSimpleType}}{{/hasReference}}
      {{^hasReference}}{{returnType}}{{/hasReference}}
    
    {{/returnType}}

    

    {{#hasExamples}}
    {{#examples}}
    Example data
    Content-Type: {{{contentType}}}
    {{{example}}}
    {{/examples}}
    {{/hasExamples}}

    {{#hasProduces}}
    Produces
    This API call produces the following media types according to the Accept request header;
    the media type will be conveyed by the Content-Type response header.
    
    {{#produces}}
      {{{mediaType}}}
    {{/produces}}
    
    {{/hasProduces}}

    Responses
    {{#responses}}
    {{code}}
    {{message}}
        {{#simpleType}}{{dataType}}{{/simpleType}}
    {{#examples}}
    Example data
    Content-Type: {{{contentType}}}
    {{example}}
    {{/examples}}
    {{/responses}}
  
 
  
  {{/operation}}
  {{/operations}}
  {{/apis}}
  {{/apiInfo}}

  Models
  [ Jump to Methods ]

  Table of Contents
  
  {{#models}}
  {{#model}}
    {{name}}{{#title}} - {{title}}{{/title}}
  {{/model}}
  {{/models}}
  

  {{#models}}
  {{#model}}
  
    {{name}}{{#title}} - {{title}}{{/title}} Up
    {{#unescapedDescription}}{{unescapedDescription}}{{/unescapedDescription}}
    
      {{#vars}}{{name}} {{^required}}(optional){{/required}}
{{^isPrimitiveType}}{{datatype}}{{/isPrimitiveType}} {{unescapedDescription}} {{#dataFormat}}format: {{{dataFormat}}}{{/dataFormat}}
      {{#isEnum}}
        Enum:
        {{#_enum}}{{this}}{{/_enum}}
      {{/isEnum}}
      {{#example}}
          example: {{example}}
      {{/example}}
      {{/vars}}
    
  
  
  {{/model}}
  {{/models}}