github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/java/libraries/retrofit/api.mustache (about)

     1  package {{package}};
     2  
     3  import {{invokerPackage}}.CollectionFormats.*;
     4  
     5  import retrofit.Callback;
     6  import retrofit.http.*;
     7  import retrofit.mime.*;
     8  
     9  {{#imports}}import {{import}};
    10  {{/imports}}
    11  
    12  {{^fullJavaUtil}}
    13  import java.util.ArrayList;
    14  import java.util.HashMap;
    15  import java.util.List;
    16  import java.util.Map;
    17  {{/fullJavaUtil}}
    18  
    19  {{#operations}}
    20  public interface {{classname}} {
    21    {{#operation}}
    22    /**
    23     * {{summary}}
    24     * Sync method
    25     * {{notes}}
    26  {{#allParams}}
    27     * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
    28  {{/allParams}}
    29     * @return {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Void{{/returnType}}
    30  {{#externalDocs}}
    31     * {{description}}
    32     * @see <a href="{{url}}">{{summary}} Documentation</a>
    33  {{/externalDocs}}
    34     */
    35    {{#formParams}}{{#-first}}
    36    {{#isMultipart}}@retrofit.http.Multipart{{/isMultipart}}{{^isMultipart}}@retrofit.http.FormUrlEncoded{{/isMultipart}}{{/-first}}{{/formParams}}
    37    @{{httpMethod}}("{{{path}}}")
    38    {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}} {{operationId}}({{^allParams}});{{/allParams}}
    39      {{#allParams}}{{>libraries/retrofit/queryParams}}{{>libraries/retrofit/pathParams}}{{>libraries/retrofit/headerParams}}{{>libraries/retrofit/bodyParams}}{{>libraries/retrofit/formParams}}{{^-last}}, {{/-last}}{{#-last}}
    40    );{{/-last}}{{/allParams}}
    41  
    42    /**
    43     * {{summary}}
    44     * Async method
    45  {{#allParams}}
    46     * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
    47  {{/allParams}}
    48     * @param cb callback method
    49  {{#externalDocs}}
    50     * {{description}}
    51     * @see <a href="{{url}}">{{summary}} Documentation</a>
    52  {{/externalDocs}}
    53     */
    54    {{#formParams}}{{#-first}}
    55    {{#isMultipart}}@retrofit.http.Multipart{{/isMultipart}}{{^isMultipart}}@retrofit.http.FormUrlEncoded{{/isMultipart}}{{/-first}}{{/formParams}}
    56    @{{httpMethod}}("{{{path}}}")
    57    void {{operationId}}(
    58      {{#allParams}}{{>libraries/retrofit/queryParams}}{{>libraries/retrofit/pathParams}}{{>libraries/retrofit/headerParams}}{{>libraries/retrofit/bodyParams}}{{>libraries/retrofit/formParams}}, {{/allParams}}Callback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> cb
    59    );
    60    {{/operation}}
    61  }
    62  {{/operations}}