github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/java/libraries/okhttp-gson/api_doc.mustache (about) 1 # {{classname}}{{#description}} 2 {{description}}{{/description}} 3 4 All URIs are relative to *{{basePath}}* 5 6 Method | HTTP request | Description 7 ------------- | ------------- | ------------- 8 {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} 9 {{/operation}}{{/operations}} 10 11 {{#operations}} 12 {{#operation}} 13 <a name="{{operationId}}"></a> 14 # **{{operationId}}**{{^vendorExtensions.x-group-parameters}} 15 > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}}){{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}} 16 > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}){{#optionalParams}}.{{paramName}}({{paramName}}){{/optionalParams}}.execute();{{/vendorExtensions.x-group-parameters}} 17 18 {{summary}}{{#notes}} 19 20 {{notes}}{{/notes}} 21 22 ### Example 23 ```java 24 // Import classes: 25 import {{{invokerPackage}}}.ApiClient; 26 import {{{invokerPackage}}}.ApiException; 27 import {{{invokerPackage}}}.Configuration;{{#hasAuthMethods}} 28 import {{{invokerPackage}}}.auth.*;{{/hasAuthMethods}} 29 import {{{invokerPackage}}}.models.*; 30 import {{{package}}}.{{{classname}}}; 31 32 public class Example { 33 public static void main(String[] args) { 34 ApiClient defaultClient = Configuration.getDefaultApiClient(); 35 defaultClient.setBasePath("{{{basePath}}}"); 36 {{#hasAuthMethods}} 37 {{#authMethods}}{{#isBasic}}{{#isBasicBasic}} 38 // Configure HTTP basic authorization: {{{name}}} 39 HttpBasicAuth {{{name}}} = (HttpBasicAuth) defaultClient.getAuthentication("{{{name}}}"); 40 {{{name}}}.setUsername("YOUR USERNAME"); 41 {{{name}}}.setPassword("YOUR PASSWORD");{{/isBasicBasic}}{{#isBasicBearer}} 42 // Configure HTTP bearer authorization: {{{name}}} 43 HttpBearerAuth {{{name}}} = (HttpBearerAuth) defaultClient.getAuthentication("{{{name}}}"); 44 {{{name}}}.setBearerToken("BEARER TOKEN");{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}} 45 // Configure API key authorization: {{{name}}} 46 ApiKeyAuth {{{name}}} = (ApiKeyAuth) defaultClient.getAuthentication("{{{name}}}"); 47 {{{name}}}.setApiKey("YOUR API KEY"); 48 {{{name}}}.setApiKeyPrefix("token");{{/isApiKey}}{{#isOAuth}} 49 // Configure OAuth2 access token for authorization: {{{name}}} 50 OAuth {{{name}}} = (OAuth) defaultClient.getAuthentication("{{{name}}}"); 51 {{{name}}}.setAccessToken("YOUR ACCESS TOKEN");{{/isOAuth}} 52 {{/authMethods}} 53 {{/hasAuthMethods}} 54 55 {{{classname}}} apiInstance = new {{{classname}}}(defaultClient); 56 {{#allParams}} 57 {{{dataType}}} {{{paramName}}} = {{{example}}}; // {{{dataType}}} | {{{description}}} 58 {{/allParams}} 59 try { 60 {{#returnType}}{{{returnType}}} result = {{/returnType}}apiInstance.{{{operationId}}}{{^vendorExtensions.x-group-parameters}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}});{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}){{#optionalParams}} 61 .{{{paramName}}}({{{paramName}}}){{/optionalParams}} 62 .execute();{{/vendorExtensions.x-group-parameters}}{{#returnType}} 63 System.out.println(result);{{/returnType}} 64 } catch (ApiException e) { 65 System.err.println("Exception when calling {{{classname}}}#{{{operationId}}}"); 66 System.err.println("Status code: " + e.getCode()); 67 System.err.println("Reason: " + e.getResponseBody()); 68 System.err.println("Response headers: " + e.getResponseHeaders()); 69 e.printStackTrace(); 70 } 71 } 72 } 73 ``` 74 75 ### Parameters 76 {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} 77 Name | Type | Description | Notes 78 ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} 79 {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{^isContainer}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{/isContainer}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}} 80 {{/allParams}} 81 82 ### Return type 83 84 {{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}} 85 86 ### Authorization 87 88 {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}} 89 90 ### HTTP request headers 91 92 - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} 93 - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} 94 95 {{#responses.0}} 96 ### HTTP response details 97 | Status code | Description | Response headers | 98 |-------------|-------------|------------------| 99 {{#responses}} 100 **{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} | 101 {{/responses}} 102 {{/responses.0}} 103 104 {{/operation}} 105 {{/operations}}