better code format in java jersey doc (#5031)

This commit is contained in:
William Cheng
2020-01-18 19:11:51 +08:00
committed by GitHub
parent 2722c602ac
commit d1948c4b41
19 changed files with 128 additions and 397 deletions

View File

@@ -25,7 +25,6 @@ Method | HTTP request | Description
> createXmlItem(xmlItem)
creates an XmlItem
this route creates an XmlItem
@@ -47,10 +46,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
XmlItem xmlItem = new XmlItem(); // XmlItem | XmlItem Body
try {
try {
apiInstance.createXmlItem(xmlItem);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#createXmlItem");
System.err.println("Status code: " + e.getCode());
@@ -94,7 +91,6 @@ No authorization required
Test serialization of outer boolean types
### Example
@@ -114,9 +110,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
Boolean body = true; // Boolean | Input boolean as post body
try {
try {
Boolean result = apiInstance.fakeOuterBooleanSerialize(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#fakeOuterBooleanSerialize");
@@ -161,7 +156,6 @@ No authorization required
Test serialization of object with outer number type
### Example
@@ -181,9 +175,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
OuterComposite body = new OuterComposite(); // OuterComposite | Input composite as post body
try {
try {
OuterComposite result = apiInstance.fakeOuterCompositeSerialize(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#fakeOuterCompositeSerialize");
@@ -228,7 +221,6 @@ No authorization required
Test serialization of outer number types
### Example
@@ -248,9 +240,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
BigDecimal body = new BigDecimal(); // BigDecimal | Input number as post body
try {
try {
BigDecimal result = apiInstance.fakeOuterNumberSerialize(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#fakeOuterNumberSerialize");
@@ -295,7 +286,6 @@ No authorization required
Test serialization of outer string types
### Example
@@ -315,9 +305,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
String body = "body_example"; // String | Input string as post body
try {
try {
String result = apiInstance.fakeOuterStringSerialize(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#fakeOuterStringSerialize");
@@ -362,7 +351,6 @@ No authorization required
For this test, the body for this request much reference a schema named `File`.
### Example
@@ -382,10 +370,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
FileSchemaTestClass body = new FileSchemaTestClass(); // FileSchemaTestClass |
try {
try {
apiInstance.testBodyWithFileSchema(body);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testBodyWithFileSchema");
System.err.println("Status code: " + e.getCode());
@@ -429,7 +415,6 @@ No authorization required
### Example
```java
@@ -448,10 +433,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
String query = "query_example"; // String |
User body = new User(); // User |
try {
try {
apiInstance.testBodyWithQueryParams(query, body);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testBodyWithQueryParams");
System.err.println("Status code: " + e.getCode());
@@ -494,7 +477,6 @@ No authorization required
> Client testClientModel(body)
To test \"client\" model
To test "client" model
@@ -516,9 +498,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
Client body = new Client(); // Client | client model
try {
try {
Client result = apiInstance.testClientModel(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testClientModel");
@@ -561,7 +542,6 @@ No authorization required
> testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters
@@ -605,10 +585,8 @@ public class Example {
OffsetDateTime dateTime = new OffsetDateTime(); // OffsetDateTime | None
String password = "password_example"; // String | None
String paramCallback = "paramCallback_example"; // String | None
try {
try {
apiInstance.testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testEndpointParameters");
System.err.println("Status code: " + e.getCode());
@@ -664,7 +642,6 @@ null (empty response body)
> testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString)
To test enum parameters
To test enum parameters
@@ -693,10 +670,8 @@ public class Example {
Double enumQueryDouble = 3.4D; // Double | Query parameter enum test (double)
List<String> enumFormStringArray = "$"; // List<String> | Form parameter enum test (string array)
String enumFormString = "-efg"; // String | Form parameter enum test (string)
try {
try {
apiInstance.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testEnumParameters");
System.err.println("Status code: " + e.getCode());
@@ -744,7 +719,6 @@ No authorization required
## testGroupParameters
> testGroupParameters().requiredStringGroup(requiredStringGroup).requiredBooleanGroup(requiredBooleanGroup).requiredInt64Group(requiredInt64Group).stringGroup(stringGroup).booleanGroup(booleanGroup).int64Group(int64Group).execute();
Fake endpoint to test group parameters (optional)
@@ -773,7 +747,7 @@ public class Example {
Integer stringGroup = 56; // Integer | String in group parameters
Boolean booleanGroup = true; // Boolean | Boolean in group parameters
Long int64Group = 56L; // Long | Integer in group parameters
try {
try {
api.testGroupParameters()
.requiredStringGroup(requiredStringGroup)
.requiredBooleanGroup(requiredBooleanGroup)
@@ -782,7 +756,6 @@ public class Example {
.booleanGroup(booleanGroup)
.int64Group(int64Group)
.execute();
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testGroupParameters");
System.err.println("Status code: " + e.getCode());
@@ -829,7 +802,6 @@ No authorization required
> testInlineAdditionalProperties(param)
test inline additionalProperties
### Example
@@ -849,10 +821,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
Map<String, String> param = new HashMap(); // Map<String, String> | request body
try {
try {
apiInstance.testInlineAdditionalProperties(param);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testInlineAdditionalProperties");
System.err.println("Status code: " + e.getCode());
@@ -894,7 +864,6 @@ No authorization required
> testJsonFormData(param, param2)
test json serialization of form data
### Example
@@ -915,10 +884,8 @@ public class Example {
FakeApi apiInstance = new FakeApi(defaultClient);
String param = "param_example"; // String | field1
String param2 = "param2_example"; // String | field2
try {
try {
apiInstance.testJsonFormData(param, param2);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testJsonFormData");
System.err.println("Status code: " + e.getCode());
@@ -963,7 +930,6 @@ No authorization required
To test the collection format in query parameters
### Example
@@ -987,10 +953,8 @@ public class Example {
List<String> http = Arrays.asList(); // List<String> |
List<String> url = Arrays.asList(); // List<String> |
List<String> context = Arrays.asList(); // List<String> |
try {
try {
apiInstance.testQueryParameterCollectionFormat(pipe, ioutil, http, url, context);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#testQueryParameterCollectionFormat");
System.err.println("Status code: " + e.getCode());