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