loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[Java][Rest-assured] Fix generated javadoc and "swagger-annotations" improvement (#831)

Browse Source 
Added "@Api" swagger annotation, "nickname" for ApiOperation. 
Fixed javadock for rest-assured client.
This commit is contained in:
Victor Orlovsky 2018-08-17 19:15:02 +03:00 committed by Jérémie Bresson
parent 0f30a052b2
commit 0191210145
7 changed files with 178 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
modules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache
View File

@ -28,6 +28,7 @@ import {{invokerPackage}}.JSON;
import static io.restassured.http.Method.*;
@Api(value = "{{{baseName}}}")
public class {{classname}} {
private RequestSpecBuilder reqSpec;
@ -45,7 +46,8 @@ public class {{classname}} {
@ApiOperation(value = "{{{summary}}}",
notes = "{{{notes}}}",
tags={ {{#tags}}{{#name}}"{{{name}}}"{{/name}}{{^-last}}, {{/-last}}{{/tags}} })
nickname = "{{{operationId}}}",
tags = { {{#tags}}{{#name}}"{{{name}}}"{{/name}}{{^-last}}, {{/-last}}{{/tags}} })
@ApiResponses(value = { {{#responses}}
@ApiResponse(code = {{{code}}}, message = "{{{message}}}") {{#hasMore}},{{/hasMore}}{{/responses}} })
{{#isDeprecated}}
@ -135,7 +137,7 @@ public class {{classname}} {
{{#bodyParams}}
/**
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper body({{{dataType}}} {{paramName}}) {
@ -148,7 +150,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_HEADER = "{{baseName}}";
/**
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Header(String {{paramName}}) {
@ -161,7 +163,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_PATH = "{{baseName}}";
/**
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Path(Object {{paramName}}) {
@ -174,7 +176,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_QUERY = "{{baseName}}";
/**
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Query(Object... {{paramName}}) {
@ -188,7 +190,7 @@ public class {{classname}} {
public static final String {{#convert}}{{paramName}}{{/convert}}_FORM = "{{baseName}}";
/**
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}Form(Object... {{paramName}}) {
@ -203,7 +205,7 @@ public class {{classname}} {
/**
* It will assume that the control name is file and the <content-type> is <application/octet-stream>
* @see #reqSpec for customise
* @param {{paramName}} ({{{dataType}}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @param {{paramName}} ({{dataType}}) {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}
* @return operation
*/
public {{operationIdCamelCase}}Oper {{paramName}}MultiPart({{{dataType}}} {{paramName}}) {

4
samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/AnotherFakeApi.java
View File

@ -36,6 +36,7 @@ import org.openapitools.client.JSON;
import static io.restassured.http.Method.*;
@Api(value = "AnotherFake")
public class AnotherFakeApi {
private RequestSpecBuilder reqSpec;
@ -51,7 +52,8 @@ public class AnotherFakeApi {
@ApiOperation(value = "To test special tags",
notes = "To test special tags and operation ID starting with number",
tags={ "$another-fake?" })
nickname = "call123testSpecialTags",
tags = { "$another-fake?" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public Call123testSpecialTagsOper call123testSpecialTags() {

42
samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/FakeApi.java
View File

@ -43,6 +43,7 @@ import org.openapitools.client.JSON;
import static io.restassured.http.Method.*;
@Api(value = "Fake")
public class FakeApi {
private RequestSpecBuilder reqSpec;
@ -58,7 +59,8 @@ public class FakeApi {
@ApiOperation(value = "",
notes = "Test serialization of outer boolean types",
tags={ "fake" })
nickname = "fakeOuterBooleanSerialize",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output boolean") })
public FakeOuterBooleanSerializeOper fakeOuterBooleanSerialize() {
@ -67,7 +69,8 @@ public class FakeApi {
@ApiOperation(value = "",
notes = "Test serialization of object with outer number type",
tags={ "fake" })
nickname = "fakeOuterCompositeSerialize",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output composite") })
public FakeOuterCompositeSerializeOper fakeOuterCompositeSerialize() {
@ -76,7 +79,8 @@ public class FakeApi {
@ApiOperation(value = "",
notes = "Test serialization of outer number types",
tags={ "fake" })
nickname = "fakeOuterNumberSerialize",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output number") })
public FakeOuterNumberSerializeOper fakeOuterNumberSerialize() {
@ -85,7 +89,8 @@ public class FakeApi {
@ApiOperation(value = "",
notes = "Test serialization of outer string types",
tags={ "fake" })
nickname = "fakeOuterStringSerialize",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output string") })
public FakeOuterStringSerializeOper fakeOuterStringSerialize() {
@ -94,7 +99,8 @@ public class FakeApi {
@ApiOperation(value = "",
notes = "For this test, the body for this request much reference a schema named `File`.",
tags={ "fake" })
nickname = "testBodyWithFileSchema",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
public TestBodyWithFileSchemaOper testBodyWithFileSchema() {
@ -103,7 +109,8 @@ public class FakeApi {
@ApiOperation(value = "",
notes = "",
tags={ "fake" })
nickname = "testBodyWithQueryParams",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
public TestBodyWithQueryParamsOper testBodyWithQueryParams() {
@ -112,7 +119,8 @@ public class FakeApi {
@ApiOperation(value = "To test \"client\" model",
notes = "To test \"client\" model",
tags={ "fake" })
nickname = "testClientModel",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public TestClientModelOper testClientModel() {
@ -121,7 +129,8 @@ public class FakeApi {
@ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ",
notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ",
tags={ "fake" })
nickname = "testEndpointParameters",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid username supplied") ,
@ApiResponse(code = 404, message = "User not found") })
@ -131,7 +140,8 @@ public class FakeApi {
@ApiOperation(value = "To test enum parameters",
notes = "To test enum parameters",
tags={ "fake" })
nickname = "testEnumParameters",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid request") ,
@ApiResponse(code = 404, message = "Not found") })
@ -141,7 +151,8 @@ public class FakeApi {
@ApiOperation(value = "test inline additionalProperties",
notes = "",
tags={ "fake" })
nickname = "testInlineAdditionalProperties",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public TestInlineAdditionalPropertiesOper testInlineAdditionalProperties() {
@ -150,7 +161,8 @@ public class FakeApi {
@ApiOperation(value = "test json serialization of form data",
notes = "",
tags={ "fake" })
nickname = "testJsonFormData",
tags = { "fake" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public TestJsonFormDataOper testJsonFormData() {
@ -913,7 +925,7 @@ public class FakeApi {
public static final String ENUM_HEADER_STRING_ARRAY_HEADER = "enum_header_string_array";
/**
* @param enumHeaderStringArray (List<String>) Header parameter enum test (string array) (optional)
* @param enumHeaderStringArray (List&lt;String&gt;) Header parameter enum test (string array) (optional)
* @return operation
*/
public TestEnumParametersOper enumHeaderStringArrayHeader(String enumHeaderStringArray) {
@ -935,7 +947,7 @@ public class FakeApi {
public static final String ENUM_QUERY_STRING_ARRAY_QUERY = "enum_query_string_array";
/**
* @param enumQueryStringArray (List<String>) Query parameter enum test (string array) (optional)
* @param enumQueryStringArray (List&lt;String&gt;) Query parameter enum test (string array) (optional)
* @return operation
*/
public TestEnumParametersOper enumQueryStringArrayQuery(Object... enumQueryStringArray) {
@ -979,7 +991,7 @@ public class FakeApi {
public static final String ENUM_FORM_STRING_ARRAY_FORM = "enum_form_string_array";
/**
* @param enumFormStringArray (List<String>) Form parameter enum test (string array) (optional, default to $)
* @param enumFormStringArray (List&lt;String&gt;) Form parameter enum test (string array) (optional, default to $)
* @return operation
*/
public TestEnumParametersOper enumFormStringArrayForm(Object... enumFormStringArray) {
@ -1050,7 +1062,7 @@ public class FakeApi {
}
/**
* @param requestBody (Map<String, String>) request body (required)
* @param requestBody (Map&lt;String, String&gt;) request body (required)
* @return operation
*/
public TestInlineAdditionalPropertiesOper body(Map<String, String> requestBody) {

4
samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java
View File

@ -36,6 +36,7 @@ import org.openapitools.client.JSON;
import static io.restassured.http.Method.*;
@Api(value = "FakeClassnameTags123")
public class FakeClassnameTags123Api {
private RequestSpecBuilder reqSpec;
@ -51,7 +52,8 @@ public class FakeClassnameTags123Api {
@ApiOperation(value = "To test class name in snake case",
notes = "To test class name in snake case",
tags={ "fake_classname_tags 123#$%^" })
nickname = "testClassname",
tags = { "fake_classname_tags 123#$%^" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public TestClassnameOper testClassname() {

32
samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/PetApi.java
View File

@ -38,6 +38,7 @@ import org.openapitools.client.JSON;
import static io.restassured.http.Method.*;
@Api(value = "Pet")
public class PetApi {
private RequestSpecBuilder reqSpec;
@ -53,7 +54,8 @@ public class PetApi {
@ApiOperation(value = "Add a new pet to the store",
notes = "",
tags={ "pet" })
nickname = "addPet",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 405, message = "Invalid input") })
public AddPetOper addPet() {
@ -62,7 +64,8 @@ public class PetApi {
@ApiOperation(value = "Deletes a pet",
notes = "",
tags={ "pet" })
nickname = "deletePet",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid pet value") })
public DeletePetOper deletePet() {
@ -71,7 +74,8 @@ public class PetApi {
@ApiOperation(value = "Finds Pets by status",
notes = "Multiple status values can be provided with comma separated strings",
tags={ "pet" })
nickname = "findPetsByStatus",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid status value") })
@ -81,7 +85,8 @@ public class PetApi {
@ApiOperation(value = "Finds Pets by tags",
notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
tags={ "pet" })
nickname = "findPetsByTags",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid tag value") })
@ -92,7 +97,8 @@ public class PetApi {
@ApiOperation(value = "Find pet by ID",
notes = "Returns a single pet",
tags={ "pet" })
nickname = "getPetById",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid ID supplied") ,
@ -103,7 +109,8 @@ public class PetApi {
@ApiOperation(value = "Update an existing pet",
notes = "",
tags={ "pet" })
nickname = "updatePet",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid ID supplied") ,
@ApiResponse(code = 404, message = "Pet not found") ,
@ -114,7 +121,8 @@ public class PetApi {
@ApiOperation(value = "Updates a pet in the store with form data",
notes = "",
tags={ "pet" })
nickname = "updatePetWithForm",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 405, message = "Invalid input") })
public UpdatePetWithFormOper updatePetWithForm() {
@ -123,7 +131,8 @@ public class PetApi {
@ApiOperation(value = "uploads an image",
notes = "",
tags={ "pet" })
nickname = "uploadFile",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public UploadFileOper uploadFile() {
@ -132,7 +141,8 @@ public class PetApi {
@ApiOperation(value = "uploads an image (required)",
notes = "",
tags={ "pet" })
nickname = "uploadFileWithRequiredFile",
tags = { "pet" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public UploadFileWithRequiredFileOper uploadFileWithRequiredFile() {
@ -326,7 +336,7 @@ public class PetApi {
public static final String STATUS_QUERY = "status";
/**
* @param status (List<String>) Status values that need to be considered for filter (required)
* @param status (List&lt;String&gt;) Status values that need to be considered for filter (required)
* @return operation
*/
public FindPetsByStatusOper statusQuery(Object... status) {
@ -400,7 +410,7 @@ public class PetApi {
public static final String TAGS_QUERY = "tags";
/**
* @param tags (List<String>) Tags to filter by (required)
* @param tags (List&lt;String&gt;) Tags to filter by (required)
* @return operation
*/
public FindPetsByTagsOper tagsQuery(Object... tags) {

13
samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/StoreApi.java
View File

@ -36,6 +36,7 @@ import org.openapitools.client.JSON;
import static io.restassured.http.Method.*;
@Api(value = "Store")
public class StoreApi {
private RequestSpecBuilder reqSpec;
@ -51,7 +52,8 @@ public class StoreApi {
@ApiOperation(value = "Delete purchase order by ID",
notes = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
tags={ "store" })
nickname = "deleteOrder",
tags = { "store" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid ID supplied") ,
@ApiResponse(code = 404, message = "Order not found") })
@ -61,7 +63,8 @@ public class StoreApi {
@ApiOperation(value = "Returns pet inventories by status",
notes = "Returns a map of status codes to quantities",
tags={ "store" })
nickname = "getInventory",
tags = { "store" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
public GetInventoryOper getInventory() {
@ -70,7 +73,8 @@ public class StoreApi {
@ApiOperation(value = "Find purchase order by ID",
notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
tags={ "store" })
nickname = "getOrderById",
tags = { "store" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid ID supplied") ,
@ -81,7 +85,8 @@ public class StoreApi {
@ApiOperation(value = "Place an order for a pet",
notes = "",
tags={ "store" })
nickname = "placeOrder",
tags = { "store" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid Order") })

29
samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/api/UserApi.java
View File

@ -36,6 +36,7 @@ import org.openapitools.client.JSON;
import static io.restassured.http.Method.*;
@Api(value = "User")
public class UserApi {
private RequestSpecBuilder reqSpec;
@ -51,7 +52,8 @@ public class UserApi {
@ApiOperation(value = "Create user",
notes = "This can only be done by the logged in user.",
tags={ "user" })
nickname = "createUser",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 0, message = "successful operation") })
public CreateUserOper createUser() {
@ -60,7 +62,8 @@ public class UserApi {
@ApiOperation(value = "Creates list of users with given input array",
notes = "",
tags={ "user" })
nickname = "createUsersWithArrayInput",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 0, message = "successful operation") })
public CreateUsersWithArrayInputOper createUsersWithArrayInput() {
@ -69,7 +72,8 @@ public class UserApi {
@ApiOperation(value = "Creates list of users with given input array",
notes = "",
tags={ "user" })
nickname = "createUsersWithListInput",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 0, message = "successful operation") })
public CreateUsersWithListInputOper createUsersWithListInput() {
@ -78,7 +82,8 @@ public class UserApi {
@ApiOperation(value = "Delete user",
notes = "This can only be done by the logged in user.",
tags={ "user" })
nickname = "deleteUser",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid username supplied") ,
@ApiResponse(code = 404, message = "User not found") })
@ -88,7 +93,8 @@ public class UserApi {
@ApiOperation(value = "Get user by user name",
notes = "",
tags={ "user" })
nickname = "getUserByName",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid username supplied") ,
@ -99,7 +105,8 @@ public class UserApi {
@ApiOperation(value = "Logs user into the system",
notes = "",
tags={ "user" })
nickname = "loginUser",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") ,
@ApiResponse(code = 400, message = "Invalid username/password supplied") })
@ -109,7 +116,8 @@ public class UserApi {
@ApiOperation(value = "Logs out current logged in user session",
notes = "",
tags={ "user" })
nickname = "logoutUser",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 0, message = "successful operation") })
public LogoutUserOper logoutUser() {
@ -118,7 +126,8 @@ public class UserApi {
@ApiOperation(value = "Updated user",
notes = "This can only be done by the logged in user.",
tags={ "user" })
nickname = "updateUser",
tags = { "user" })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid user supplied") ,
@ApiResponse(code = 404, message = "User not found") })
@ -228,7 +237,7 @@ public class UserApi {
}
/**
* @param user (List<User>) List of user object (required)
* @param user (List&lt;User&gt;) List of user object (required)
* @return operation
*/
public CreateUsersWithArrayInputOper body(List<User> user) {
@ -288,7 +297,7 @@ public class UserApi {
}
/**
* @param user (List<User>) List of user object (required)
* @param user (List&lt;User&gt;) List of user object (required)
* @return operation
*/
public CreateUsersWithListInputOper body(List<User> user) {