github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/java/libraries/rest-assured/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}}**
    15  > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}})
    16  
    17  {{summary}}{{#notes}}
    18  
    19  {{notes}}{{/notes}}
    20  
    21  ### Example
    22  ```java
    23  // Import classes:
    24  //import {{invokerPackage}}.ApiClient;
    25  //import io.restassured.builder.RequestSpecBuilder;
    26  //import io.restassured.filter.log.ErrorLoggingFilter;
    27  
    28  {{classname}} api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
    29                  () -> new RequestSpecBuilder()
    30                          .setBaseUri("{{basePath}}"))).{{classVarName}}();
    31  
    32  api.{{operationId}}(){{#allParams}}{{#required}}{{#isPathParam}}
    33      .{{paramName}}Path({{paramName}}){{/isPathParam}}{{#isQueryParam}}
    34      .{{paramName}}Query({{paramName}}){{/isQueryParam}}{{#isFormParam}}{{^isFile}}
    35      .{{paramName}}Form({{paramName}}){{/isFile}}{{/isFormParam}}{{#isFormParam}}{{#isFile}}
    36      .{{paramName}}MultiPart({{paramName}}){{/isFile}}{{/isFormParam}}{{#isHeaderParam}}
    37      .{{paramName}}Header({{paramName}}){{/isHeaderParam}}{{#isBodyParam}}
    38      .body({{paramName}}){{/isBodyParam}}{{/required}}{{/allParams}}.execute(r -> r.prettyPeek());
    39  ```
    40  
    41  ### Parameters
    42  {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
    43  Name | Type | Description  | Notes
    44  ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
    45  {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}
    46  {{/allParams}}
    47  
    48  ### Return type
    49  
    50  {{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}
    51  
    52  ### Authorization
    53  
    54  {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}
    55  
    56  ### HTTP request headers
    57  
    58   - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
    59   - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}
    60  
    61  {{/operation}}
    62  {{/operations}}