htmlDocs2.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}}}
  
  
  


{{>js_jquery}}

{{>js_prettify}}
{{>js_bootstrap}}








  


    
        
            
                


                    
                    
                    API Summary

                    {{#apiInfo}}

                        {{#apis}}
                            {{#operations}}
                                API Methods - {{baseName}}
                                {{#operation}}
                                    
                                        {{nickname}}
                                    
                                {{/operation}}
                            {{/operations}}
                        {{/apis}}

                    {{/apiInfo}}



                
            
        
        
            
                
                    {{{appName}}}
                
                
            
            
                
                    API and SDK Documentation

                    {{#version}}
                        Version: {{{version}}}
                    {{/version}}


                    

                    {{{appDescription}}}
                
            
            

                {{#apiInfo}}

                    {{#apis}}
                        {{#operations}}
                            
                                {{baseName}}
                                {{#operation}}







                                    

                                        
                                            
                                                {{nickname}}
                                            
                                            

                                            
                                            

                                            
                                            {{notes}}
                                            
                                            


                                            {{path}}

                                            
                                                
Usage and SDK Samples
                                            

                                            
                                                
                                                    Curl
                                                
                                                
              Java
            
            
              Android
            
            
                                                
                                                    Obj-C
                                                
                                                
                                                    JavaScript
                                                
                                                
                                                
                                                    C#
                                                
                                                
              PHP
            
                                            

                                            
                                                
                                                    
curl -X {{httpMethod}} -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "{{basePath}}{{path}}{{#hasQueryParams}}?{{#queryParams}}{{^-first}}&{{/-first}}{{paramName}}={{vendorExtensions.x-eg}}{{/queryParams}}{{/hasQueryParams}}"



                                                

                                                
                                                  
{{>sample_java}}
                                                  
          


                                                
                                                  
{{>sample_android}}
                                                  
          

          


                                                
                                                    
{{>sample_objc}}
                                                    
                                                
                                                
                                                    
{{>sample_js}}
                                                    
                                                

                                                

                                                
                                                    
{{>sample_csharp}}
                                                    
                                                


                                                
                                                  
{{>sample_php}}
                                                  
          

                                            





                                            Parameters



                                            {{#hasPathParams}}
                                                Path parameters
                                                
                                                    {{#pathParams}}
                                                        {{>param}}
                                                    {{/pathParams}}
                                                
                                                    
                                                        Name
                                                        Description
                                                    
                                                    
                                            {{/hasPathParams}}

                                            {{#hasHeaderParams}}
                                                Header parameters
                                                
                                                    {{#headerParams}}
                                                        {{>param}}
                                                    {{/headerParams}}

                                                
                                                    
                                                        Name
                                                        Description
                                                    
                                                    
                                            {{/hasHeaderParams}}


                                            {{#hasBodyParam}}
                                                Body parameters
                                                
                                                    {{#bodyParams}}
                                                        {{>paramB}}
                                                    {{/bodyParams}}

                                                
                                                    
                                                        Name
                                                        Description
                                                    
                                                    
                                            {{/hasBodyParam}}

                                            {{#hasQueryParams}}
                                                Query parameters
                                                
                                                    {{#queryParams}}
                                                        {{>param}}
                                                    {{/queryParams}}
                                                
                                                    
                                                        Name
                                                        Description
                                                    
                                                    
                                            {{/hasQueryParams}}

                                            Responses
                                            {{#responses}}

                                                 Status: {{code}} - {{message}} 

                                                

                                                    
                                                        Schema
                                                    

                                                    {{#examples}}
                                                        
                                                            Response Example
                                                        
                                                    {{/examples}}

                                                







                                                



                                                    




                                                        

                                                            
                                                        
                                                        






                                                    


                                                    {{#examples}}
                                                        
                                                            {{example}}
                                                        
                                                    {{/examples}}


                                                



                                            {{/responses}}






                                        

                                    

                                    

                                {{/operation}}
                            

                        {{/operations}}
                    {{/apis}}

                {{/apiInfo}}




            






            
                
                    Suggestions, contact, support and error reporting;
                        {{#infoUrl}}
                            
Information URL: {{{infoUrl}}}
                        {{/infoUrl}}
                        {{#infoEmail}}
                            Contact Info: {{{infoEmail}}}
                        {{/infoEmail}}
                    
                    {{#licenseInfo}}
                        {{{licenseInfo}}}
                    {{/licenseInfo}}
                    {{#licenseUrl}}
                        {{{licenseUrl}}}
                    {{/licenseUrl}}
                
            
            
                
                    Generated {{generatedDate}}
                
            
        
    







{{>js_jsonschemaview}}
{{>js_jsonref}}
{{>js_webfontloader}}