add markdown docs for java api client using retrofit2; #2968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

wing328 merged 1 commit into swagger-api:master from zhenjun115:java_api_client

May 30, 2016

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaClientCodegen.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -332,6 +332,13 @@ public void processOpts() { @@
                         gradleWrapperPackage.replace( ".", File.separator ), "gradle-wrapper.properties") );
                 supportingFiles.add( new SupportingFile( "gradle-wrapper.jar",
                         gradleWrapperPackage.replace( ".", File.separator ), "gradle-wrapper.jar") );
+                //generate markdown docs for retrofit2
+                if ( usesRetrofit2Library() ){
+                    modelDocTemplateFiles.put("model_doc.mustache", ".md");
+                    apiDocTemplateFiles.put("api_doc.mustache", ".md");
+                }
             } else if("jersey2".equals(getLibrary())) {
                 // generate markdown docs
                 modelDocTemplateFiles.put("model_doc.mustache", ".md");
@@ Expand Down @@

samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesClass.md

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    # AdditionalPropertiesClass
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------

samples/client/petstore/java/retrofit2/docs/Animal.md

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    # Animal
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **className** | **String** |  |
+    **color** | **String** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/AnimalFarm.md

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    # AnimalFarm
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------

samples/client/petstore/java/retrofit2/docs/ArrayTest.md

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    # ArrayTest
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------

samples/client/petstore/java/retrofit2/docs/Cat.md

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    # Cat
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **className** | **String** |  |
+    **color** | **String** |  |  [optional]
+    **declawed** | **Boolean** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/Category.md

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    # Category
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **id** | **Long** |  |  [optional]
+    **name** | **String** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/Dog.md

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    # Dog
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **className** | **String** |  |
+    **color** | **String** |  |  [optional]
+    **breed** | **String** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/EnumClass.md

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    # EnumClass
+    ## Enum
+    * `_ABC` (value: `"_abc"`)
+    * `_EFG` (value: `"-efg"`)
+    * `_XYZ_` (value: `"(xyz)"`)

samples/client/petstore/java/retrofit2/docs/EnumTest.md

-Original file line number
+Diff line change
@@ -0,0 +1,36 @@
+    # EnumTest
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **enumString** | [**EnumStringEnum**](#EnumStringEnum) |  |  [optional]
+    **enumInteger** | [**EnumIntegerEnum**](#EnumIntegerEnum) |  |  [optional]
+    **enumNumber** | [**EnumNumberEnum**](#EnumNumberEnum) |  |  [optional]
+    <a name="EnumStringEnum"></a>
+    ## Enum: EnumStringEnum
+    Name | Value
+    ---- | -----
+    UPPER | &quot;UPPER&quot;
+    LOWER | &quot;lower&quot;
+    <a name="EnumIntegerEnum"></a>
+    ## Enum: EnumIntegerEnum
+    Name | Value
+    ---- | -----
+    NUMBER_1 | 1
+    NUMBER_MINUS_1 | -1
+    <a name="EnumNumberEnum"></a>
+    ## Enum: EnumNumberEnum
+    Name | Value
+    ---- | -----
+    NUMBER_1_DOT_1 | 1.1
+    NUMBER_MINUS_1_DOT_2 | -1.2

samples/client/petstore/java/retrofit2/docs/FakeApi.md

-Original file line number
+Diff line change
@@ -0,0 +1,76 @@
+    # FakeApi
+    All URIs are relative to *http://petstore.swagger.io/v2*
+    Method | HTTP request | Description
+    ------------- | ------------- | -------------
+    [**testEndpointParameters**](FakeApi.md#testEndpointParameters) | **POST** fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
+    <a name="testEndpointParameters"></a>
+    # **testEndpointParameters**
+    > Void testEndpointParameters(number, _double, string, _byte, integer, int32, int64, _float, binary, date, dateTime, password)
+    Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
+    Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
+    ### Example
+    ```java
+    // Import classes:
+    //import io.swagger.client.ApiException;
+    //import io.swagger.client.api.FakeApi;
+    FakeApi apiInstance = new FakeApi();
+    BigDecimal number = new BigDecimal(); // BigDecimal | None
+    Double _double = 3.4D; // Double | None
+    String string = "string_example"; // String | None
+    byte[] _byte = B; // byte[] | None
+    Integer integer = 56; // Integer | None
+    Integer int32 = 56; // Integer | None
+    Long int64 = 789L; // Long | None
+    Float _float = 3.4F; // Float | None
+    byte[] binary = B; // byte[] | None
+    Date date = new Date(); // Date | None
+    Date dateTime = new Date(); // Date | None
+    String password = "password_example"; // String | None
+    try {
+        Void result = apiInstance.testEndpointParameters(number, _double, string, _byte, integer, int32, int64, _float, binary, date, dateTime, password);
+        System.out.println(result);
+    } catch (ApiException e) {
+        System.err.println("Exception when calling FakeApi#testEndpointParameters");
+        e.printStackTrace();
+    }
+    ```
+    ### Parameters
+    Name | Type | Description  | Notes
+    ------------- | ------------- | ------------- | -------------
+     **number** | **BigDecimal**| None |
+     **_double** | **Double**| None |
+     **string** | **String**| None |
+     **_byte** | **byte[]**| None |
+     **integer** | **Integer**| None | [optional]
+     **int32** | **Integer**| None | [optional]
+     **int64** | **Long**| None | [optional]
+     **_float** | **Float**| None | [optional]
+     **binary** | **byte[]**| None | [optional]
+     **date** | **Date**| None | [optional]
+     **dateTime** | **Date**| None | [optional]
+     **password** | **String**| None | [optional]
+    ### Return type
+    [**Void**](.md)
+    ### Authorization
+    No authorization required
+    ### HTTP request headers
+     - **Content-Type**: application/xml; charset=utf-8, application/json; charset=utf-8
+     - **Accept**: application/xml; charset=utf-8, application/json; charset=utf-8

samples/client/petstore/java/retrofit2/docs/FormatTest.md

-Original file line number
+Diff line change
@@ -0,0 +1,22 @@
+    # FormatTest
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **integer** | **Integer** |  |  [optional]
+    **int32** | **Integer** |  |  [optional]
+    **int64** | **Long** |  |  [optional]
+    **number** | [**BigDecimal**](BigDecimal.md) |  |
+    **_float** | **Float** |  |  [optional]
+    **_double** | **Double** |  |  [optional]
+    **string** | **String** |  |  [optional]
+    **_byte** | **byte[]** |  |
+    **binary** | **byte[]** |  |  [optional]
+    **date** | [**Date**](Date.md) |  |
+    **dateTime** | [**Date**](Date.md) |  |  [optional]
+    **uuid** | **String** |  |  [optional]
+    **password** | **String** |  |

...ent/petstore/java/retrofit2/docs/MixedPropertiesAndAdditionalPropertiesClass.md

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    # MixedPropertiesAndAdditionalPropertiesClass
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **uuid** | **String** |  |  [optional]
+    **dateTime** | [**Date**](Date.md) |  |  [optional]

samples/client/petstore/java/retrofit2/docs/Model200Response.md

-Original file line number
+Diff line change
@@ -0,0 +1,10 @@
+    # Model200Response
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **name** | **Integer** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/ModelApiResponse.md

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    # ModelApiResponse
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **code** | **Integer** |  |  [optional]
+    **type** | **String** |  |  [optional]
+    **message** | **String** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/ModelReturn.md

-Original file line number
+Diff line change
@@ -0,0 +1,10 @@
+    # ModelReturn
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **_return** | **Integer** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/Name.md

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    # Name
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **name** | **Integer** |  |
+    **snakeCase** | **Integer** |  |  [optional]
+    **property** | **String** |  |  [optional]
+    **_123Number** | **Integer** |  |  [optional]

samples/client/petstore/java/retrofit2/docs/Order.md

-Original file line number
+Diff line change
@@ -0,0 +1,24 @@
+    # Order
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **id** | **Long** |  |  [optional]
+    **petId** | **Long** |  |  [optional]
+    **quantity** | **Integer** |  |  [optional]
+    **shipDate** | [**Date**](Date.md) |  |  [optional]
+    **status** | [**StatusEnum**](#StatusEnum) | Order Status |  [optional]
+    **complete** | **Boolean** |  |  [optional]
+    <a name="StatusEnum"></a>
+    ## Enum: StatusEnum
+    Name | Value
+    ---- | -----
+    PLACED | &quot;placed&quot;
+    APPROVED | &quot;approved&quot;
+    DELIVERED | &quot;delivered&quot;

samples/client/petstore/java/retrofit2/docs/Pet.md

-Original file line number
+Diff line change
@@ -0,0 +1,24 @@
+    # Pet
+    ## Properties
+    Name | Type | Description | Notes
+    ------------ | ------------- | ------------- | -------------
+    **id** | **Long** |  |  [optional]
+    **category** | [**Category**](Category.md) |  |  [optional]
+    **name** | **String** |  |
+    **photoUrls** | **List&lt;String&gt;** |  |
+    **tags** | [**List&lt;Tag&gt;**](Tag.md) |  |  [optional]
+    **status** | [**StatusEnum**](#StatusEnum) | pet status in the store |  [optional]
+    <a name="StatusEnum"></a>
+    ## Enum: StatusEnum
+    Name | Value
+    ---- | -----
+    AVAILABLE | &quot;available&quot;
+    PENDING | &quot;pending&quot;
+    SOLD | &quot;sold&quot;

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add markdown docs for java api client using retrofit2; #2968

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!