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