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

     1  package {{package}};
     2  
     3  import {{invokerPackage}}.CollectionFormats.*;
     4  
     5  {{#useRxJava}}
     6  import rx.Observable;
     7  {{/useRxJava}}
     8  {{#useRxJava2}}
     9  import io.reactivex.Observable;
    10  {{/useRxJava2}}
    11  {{^returnType}}
    12  {{#useRxJava2}}
    13  import io.reactivex.Completable;
    14  {{/useRxJava2}}
    15  {{/returnType}}
    16  {{#doNotUseRx}}
    17  import retrofit2.Call;
    18  {{/doNotUseRx}}
    19  import retrofit2.http.*;
    20  
    21  import okhttp3.RequestBody;
    22  import okhttp3.ResponseBody;
    23  import okhttp3.MultipartBody;
    24  
    25  {{#imports}}import {{import}};
    26  {{/imports}}
    27  
    28  {{^fullJavaUtil}}
    29  import java.util.ArrayList;
    30  import java.util.HashMap;
    31  import java.util.List;
    32  import java.util.Map;
    33  {{/fullJavaUtil}}
    34  
    35  {{#operations}}
    36  public interface {{classname}} {
    37    {{#operation}}
    38    /**
    39     * {{summary}}
    40     * {{notes}}
    41  {{#allParams}}
    42     * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
    43  {{/allParams}}
    44     * @return {{^doNotUseRx}}{{#useRxJava}}Observable<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Void{{/returnType}}{{/isResponseFile}}>{{/useRxJava}}{{#useRxJava2}}{{#returnType}}Observable<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{returnType}}{{/isResponseFile}}>{{/returnType}}{{^returnType}}Completable{{/returnType}}{{/useRxJava2}}{{/doNotUseRx}}{{#doNotUseRx}}Call<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Void{{/returnType}}{{/isResponseFile}}>{{/doNotUseRx}}
    45  {{#isDeprecated}}
    46     * @deprecated
    47  {{/isDeprecated}}
    48  {{#externalDocs}}
    49     * {{description}}
    50     * @see <a href="{{url}}">{{summary}} Documentation</a>
    51  {{/externalDocs}}
    52     */
    53    {{#isDeprecated}}
    54    @Deprecated
    55    {{/isDeprecated}}
    56    {{#formParams}}
    57    {{#-first}}
    58    {{#isMultipart}}@retrofit2.http.Multipart{{/isMultipart}}{{^isMultipart}}@retrofit2.http.FormUrlEncoded{{/isMultipart}}
    59    {{/-first}}
    60    {{/formParams}}
    61    {{^formParams}}
    62    {{#prioritizedContentTypes}}
    63    {{#-first}}
    64    @Headers({
    65      "Content-Type:{{{mediaType}}}"
    66    })
    67    {{/-first}}
    68    {{/prioritizedContentTypes}}
    69    {{/formParams}}
    70    @{{httpMethod}}("{{{path}}}")
    71    {{^doNotUseRx}}{{#useRxJava}}Observable<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}{{/isResponseFile}}>{{/useRxJava}}{{#useRxJava2}}{{#returnType}}Observable<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}>{{/returnType}}{{^returnType}}Completable{{/returnType}}{{/useRxJava2}}{{/doNotUseRx}}{{#doNotUseRx}}Call<{{#isResponseFile}}ResponseBody{{/isResponseFile}}{{^isResponseFile}}{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}{{/isResponseFile}}>{{/doNotUseRx}} {{operationId}}({{^allParams}});{{/allParams}}
    72      {{#allParams}}{{>libraries/retrofit2/queryParams}}{{>libraries/retrofit2/pathParams}}{{>libraries/retrofit2/headerParams}}{{>libraries/retrofit2/bodyParams}}{{>libraries/retrofit2/formParams}}{{^-last}}, {{/-last}}{{#-last}}
    73    );{{/-last}}{{/allParams}}
    74  
    75    {{/operation}}
    76  }
    77  {{/operations}}