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

[Java Spring OAS3] Fix numerous OAS3 related Bugs (#11181)

Browse Source 
* Oas3: Remove swagger2 ApiModel and ApiModelProperty from imports when oas3 is true.

* Oas3: Use either swagger v2 or v3; add test config

* Oas3: allowableValues and defaultValues belong to the Schema annotation

* Oas3: use swagger-core.version property in all pom.xml

* gh-11165 remove io.swagger.v3.oas.annotations.parameters.RequestBody

* gh-11168 add import for io.swagger.v3.oas.annotations.Hidden

* Fix formParams.mustache, add dedicated test scripts for the spring generator using oas3.

* Run ./bin/generate-samples.sh

* Run ./bin/generate-samples.sh - new samples

* fix indentation

* Revert to threetenbp 2.9.10 because customInstantDeserializer.mustache is not compatible with threetenbp > 2.9.10.

* apiController.mustache: pull in osa3 imports.

* apiDelegate.mustache: remove io.swagger.annotations.* import

* Remove Hidden (import and usage). Wrap atApiIgnore with useSpringfox.

* fully qualify org.springframework.data.domain.Pageable because endorExtensions.x-spring-paginated is not set during import processing.

* align spring-cloud and spring-boot pom.mustache regarding springfox and oas versions.

* introduce dateTimeParam.mustache

* Apply DateTimeFormat consistently across different parameter types

* revert to springfox 2.9.2

* add newline after parameter

* fix atSchema annotation (use empty description)

* add more spring-*-oas3 test configs

* Update bin/config/spring* test samples

* Fix implicitHeader.mustache - add import, generate use paramDoc.

* rename spring-boot-implicitHeaders-oal3.yaml to spring-boot-implicitHeaders-oas3.yaml

* Add spring oas3 configs to samples.circleci profiles module list

* Use groupId 'org.openapitools.openapi3' for oas3 configs

* Run all spring test configs.

* In OAS3, allowableValues is a String[] array.

* formParams.mustache: Align spacing and newlines with other param templates

* Support @Parameter(hidden = true) instead of ApiIgnore, Formatting: One parameter per line.

* Format method level annotations in api.mustache

* Introduce samples.circleci.spring profile

* Generate all spring samples
This commit is contained in:
cachescrubber
2022-01-02 14:05:46 +01:00
committed by GitHub
parent b0c0461d27
commit e71ee1bf43
728 changed files with 91024 additions and 9444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/AnotherFakeApi.java
View File

@@ -28,11 +28,16 @@ public interface AnotherFakeApi {
* @param body client model (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "To test special tags", nickname = "call123testSpecialTags", notes = "To test special tags and operation ID starting with number", response = Client.class, tags={ "$another-fake?", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
@ApiOperation(
tags = { "$another-fake?" },
value = "To test special tags",
nickname = "call123testSpecialTags",
notes = "To test special tags and operation ID starting with number",
response = Client.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Client.class)
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/another-fake/dummy",
@@ -40,7 +45,7 @@ public interface AnotherFakeApi {
consumes = { "application/json" }
)
ResponseEntity<Client> call123testSpecialTags(
@ApiParam(value = "client model", required = true ) @Valid @RequestBody Client body);
@ApiParam(value = "client model", required = true) @Valid @RequestBody Client body
);
}

4
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/AnotherFakeApiController.java
View File

@@ -41,8 +41,8 @@ public class AnotherFakeApiController implements AnotherFakeApi {
* @see AnotherFakeApi#call123testSpecialTags
*/
public ResponseEntity<Client> call123testSpecialTags(
@ApiParam(value = "client model", required = true ) @Valid @RequestBody Client body) {
@ApiParam(value = "client model", required = true) @Valid @RequestBody Client body
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"client\" : \"client\" }";

401
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
View File

@@ -37,19 +37,23 @@ public interface FakeApi {
* @param xmlItem XmlItem Body (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "creates an XmlItem", nickname = "createXmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "fake" },
value = "creates an XmlItem",
nickname = "createXmlItem",
notes = "this route creates an XmlItem"
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/create_xml_item",
consumes = { "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" }
)
ResponseEntity<Void> createXmlItem(
@ApiParam(value = "XmlItem Body", required = true ) @Valid @RequestBody XmlItem xmlItem);
@ApiParam(value = "XmlItem Body", required = true) @Valid @RequestBody XmlItem xmlItem
);
/**
@@ -59,19 +63,24 @@ public interface FakeApi {
* @param body Input boolean as post body (optional)
* @return Output boolean (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterBooleanSerialize", notes = "Test serialization of outer boolean types", response = Boolean.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "fakeOuterBooleanSerialize",
notes = "Test serialization of outer boolean types",
response = Boolean.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "Output boolean", response = Boolean.class)
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/boolean",
produces = { "*/*" }
)
ResponseEntity<Boolean> fakeOuterBooleanSerialize(
@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body);
@ApiParam(value = "Input boolean as post body") @Valid @RequestBody(required = false) Boolean body
);
/**
@@ -81,19 +90,24 @@ public interface FakeApi {
* @param body Input composite as post body (optional)
* @return Output composite (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterCompositeSerialize", notes = "Test serialization of object with outer number type", response = OuterComposite.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "fakeOuterCompositeSerialize",
notes = "Test serialization of object with outer number type",
response = OuterComposite.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class)
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/composite",
produces = { "*/*" }
)
ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(
@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body);
@ApiParam(value = "Input composite as post body") @Valid @RequestBody(required = false) OuterComposite body
);
/**
@@ -103,19 +117,24 @@ public interface FakeApi {
* @param body Input number as post body (optional)
* @return Output number (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterNumberSerialize", notes = "Test serialization of outer number types", response = BigDecimal.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "fakeOuterNumberSerialize",
notes = "Test serialization of outer number types",
response = BigDecimal.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "Output number", response = BigDecimal.class)
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/number",
produces = { "*/*" }
)
ResponseEntity<BigDecimal> fakeOuterNumberSerialize(
@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body);
@ApiParam(value = "Input number as post body") @Valid @RequestBody(required = false) BigDecimal body
);
/**
@@ -125,19 +144,24 @@ public interface FakeApi {
* @param body Input string as post body (optional)
* @return Output string (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterStringSerialize", notes = "Test serialization of outer string types", response = String.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output string", response = String.class) })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "fakeOuterStringSerialize",
notes = "Test serialization of outer string types",
response = String.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "Output string", response = String.class)
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/string",
produces = { "*/*" }
)
ResponseEntity<String> fakeOuterStringSerialize(
@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body);
@ApiParam(value = "Input string as post body") @Valid @RequestBody(required = false) String body
);
/**
@@ -147,19 +171,23 @@ public interface FakeApi {
* @param body (required)
* @return Success (status code 200)
*/
@ApiOperation(value = "", nickname = "testBodyWithFileSchema", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "testBodyWithFileSchema",
notes = "For this test, the body for this request much reference a schema named `File`."
)
@ApiResponses({
@ApiResponse(code = 200, message = "Success")
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/fake/body-with-file-schema",
consumes = { "application/json" }
)
ResponseEntity<Void> testBodyWithFileSchema(
@ApiParam(value = "", required = true ) @Valid @RequestBody FileSchemaTestClass body);
@ApiParam(value = "", required = true) @Valid @RequestBody FileSchemaTestClass body
);
/**
@@ -169,21 +197,24 @@ public interface FakeApi {
* @param body (required)
* @return Success (status code 200)
*/
@ApiOperation(value = "", nickname = "testBodyWithQueryParams", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "testBodyWithQueryParams",
notes = ""
)
@ApiResponses({
@ApiResponse(code = 200, message = "Success")
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/fake/body-with-query-params",
consumes = { "application/json" }
)
ResponseEntity<Void> testBodyWithQueryParams(@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "query", required = true) String query
,
@ApiParam(value = "", required = true ) @Valid @RequestBody User body);
ResponseEntity<Void> testBodyWithQueryParams(
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "query", required = true) String query,
@ApiParam(value = "", required = true) @Valid @RequestBody User body
);
/**
@@ -193,11 +224,16 @@ public interface FakeApi {
* @param body client model (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "To test \"client\" model", nickname = "testClientModel", notes = "To test \"client\" model", response = Client.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
@ApiOperation(
tags = { "fake" },
value = "To test \"client\" model",
nickname = "testClientModel",
notes = "To test \"client\" model",
response = Client.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Client.class)
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/fake",
@@ -205,8 +241,8 @@ public interface FakeApi {
consumes = { "application/json" }
)
ResponseEntity<Client> testClientModel(
@ApiParam(value = "client model", required = true ) @Valid @RequestBody Client body);
@ApiParam(value = "client model", required = true) @Valid @RequestBody Client body
);
/**
@@ -230,50 +266,40 @@ public interface FakeApi {
* @return Invalid username supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트", nickname = "testEndpointParameters", notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트", authorizations = {
@Authorization(value = "http_basic_test")
}, tags={ "fake", })
@ApiResponses(value = {
@ApiOperation(
tags = { "fake" },
value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트",
nickname = "testEndpointParameters",
notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트",
authorizations = {
@Authorization(value = "http_basic_test")
}
)
@ApiResponses({
@ApiResponse(code = 400, message = "Invalid username supplied"),
@ApiResponse(code = 404, message = "User not found") })
@ApiResponse(code = 404, message = "User not found")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake",
consumes = { "application/x-www-form-urlencoded" }
)
ResponseEntity<Void> testEndpointParameters(
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "number", required = true) BigDecimal number,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "double", required = true) Double _double,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "byte", required = true) byte[] _byte,
@ApiParam(value = "None") @Valid @RequestPart(value = "integer", required = false) Integer integer,
@ApiParam(value = "None") @Valid @RequestPart(value = "int32", required = false) Integer int32,
@ApiParam(value = "None") @Valid @RequestPart(value = "int64", required = false) Long int64,
@ApiParam(value = "None") @Valid @RequestPart(value = "float", required = false) Float _float,
@ApiParam(value = "None") @Valid @RequestPart(value = "string", required = false) String string,
@ApiParam(value = "None") @Valid @RequestPart(value = "binary", required = false) MultipartFile binary,
@ApiParam(value = "None") @Valid @RequestPart(value = "date", required = false) LocalDate date,
@ApiParam(value = "None") @Valid @RequestPart(value = "dateTime", required = false) OffsetDateTime dateTime,
@ApiParam(value = "None") @Valid @RequestPart(value = "password", required = false) String password,
@ApiParam(value = "None") @Valid @RequestPart(value = "callback", required = false) String paramCallback);
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "number", required = true) BigDecimal number,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "double", required = true) Double _double,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "byte", required = true) byte[] _byte,
@ApiParam(value = "None") @Valid @RequestPart(value = "integer", required = false) Integer integer,
@ApiParam(value = "None") @Valid @RequestPart(value = "int32", required = false) Integer int32,
@ApiParam(value = "None") @Valid @RequestPart(value = "int64", required = false) Long int64,
@ApiParam(value = "None") @Valid @RequestPart(value = "float", required = false) Float _float,
@ApiParam(value = "None") @Valid @RequestPart(value = "string", required = false) String string,
@ApiParam(value = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@ApiParam(value = "None") @Valid @RequestPart(value = "date", required = false) @org.springframework.format.annotation.DateTimeFormat(iso = org.springframework.format.annotation.DateTimeFormat.ISO.DATE) LocalDate date,
@ApiParam(value = "None") @Valid @RequestPart(value = "dateTime", required = false) @org.springframework.format.annotation.DateTimeFormat(iso = org.springframework.format.annotation.DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@ApiParam(value = "None") @Valid @RequestPart(value = "password", required = false) String password,
@ApiParam(value = "None") @Valid @RequestPart(value = "callback", required = false) String paramCallback
);
/**
@@ -291,35 +317,31 @@ public interface FakeApi {
* @return Invalid request (status code 400)
* or Not found (status code 404)
*/
@ApiOperation(value = "To test enum parameters", nickname = "testEnumParameters", notes = "To test enum parameters", tags={ "fake", })
@ApiResponses(value = {
@ApiOperation(
tags = { "fake" },
value = "To test enum parameters",
nickname = "testEnumParameters",
notes = "To test enum parameters"
)
@ApiResponses({
@ApiResponse(code = 400, message = "Invalid request"),
@ApiResponse(code = 404, message = "Not found") })
@ApiResponse(code = 404, message = "Not found")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake",
consumes = { "application/x-www-form-urlencoded" }
)
ResponseEntity<Void> testEnumParameters(
@ApiParam(value = "Header parameter enum test (string array)", allowableValues = ">, $") @RequestHeader(value = "enum_header_string_array", required = false) List<String> enumHeaderStringArray
,
@ApiParam(value = "Header parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @RequestHeader(value = "enum_header_string", required = false) String enumHeaderString
,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray
,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue = "-efg") String enumQueryString
,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger
,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1.1, -1.2") @Valid @RequestParam(value = "enum_query_double", required = false) Double enumQueryDouble
,
@ApiParam(value = "Form parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestPart(value = "enum_form_string_array", required = false) List<String> enumFormStringArray,
@ApiParam(value = "Form parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestPart(value = "enum_form_string", required = false) String enumFormString);
@ApiParam(value = "Header parameter enum test (string array)", allowableValues = ">, $") @RequestHeader(value = "enum_header_string_array", required = false) List<String> enumHeaderStringArray,
@ApiParam(value = "Header parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @RequestHeader(value = "enum_header_string", required = false) String enumHeaderString,
@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray,
@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue = "-efg") String enumQueryString,
@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,
@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1.1, -1.2") @Valid @RequestParam(value = "enum_query_double", required = false) Double enumQueryDouble,
@ApiParam(value = "Form parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestPart(value = "enum_form_string_array", required = false) List<String> enumFormStringArray,
@ApiParam(value = "Form parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestPart(value = "enum_form_string", required = false) String enumFormString
);
/**
@@ -334,28 +356,27 @@ public interface FakeApi {
* @param int64Group Integer in group parameters (optional)
* @return Someting wrong (status code 400)
*/
@ApiOperation(value = "Fake endpoint to test group parameters (optional)", nickname = "testGroupParameters", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Someting wrong") })
@ApiOperation(
tags = { "fake" },
value = "Fake endpoint to test group parameters (optional)",
nickname = "testGroupParameters",
notes = "Fake endpoint to test group parameters (optional)"
)
@ApiResponses({
@ApiResponse(code = 400, message = "Someting wrong")
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/fake"
)
ResponseEntity<Void> testGroupParameters(@NotNull @ApiParam(value = "Required String in group parameters", required = true) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup
,
@ApiParam(value = "Required Boolean in group parameters", required = true) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup
,@NotNull @ApiParam(value = "Required Integer in group parameters", required = true) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group
,@ApiParam(value = "String in group parameters") @Valid @RequestParam(value = "string_group", required = false) Integer stringGroup
,
@ApiParam(value = "Boolean in group parameters") @RequestHeader(value = "boolean_group", required = false) Boolean booleanGroup
,@ApiParam(value = "Integer in group parameters") @Valid @RequestParam(value = "int64_group", required = false) Long int64Group
);
ResponseEntity<Void> testGroupParameters(
@NotNull @ApiParam(value = "Required String in group parameters", required = true) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup,
@ApiParam(value = "Required Boolean in group parameters", required = true) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup,
@NotNull @ApiParam(value = "Required Integer in group parameters", required = true) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group,
@ApiParam(value = "String in group parameters") @Valid @RequestParam(value = "string_group", required = false) Integer stringGroup,
@ApiParam(value = "Boolean in group parameters") @RequestHeader(value = "boolean_group", required = false) Boolean booleanGroup,
@ApiParam(value = "Integer in group parameters") @Valid @RequestParam(value = "int64_group", required = false) Long int64Group
);
/**
@@ -364,19 +385,23 @@ public interface FakeApi {
* @param param request body (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "test inline additionalProperties", nickname = "testInlineAdditionalProperties", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "fake" },
value = "test inline additionalProperties",
nickname = "testInlineAdditionalProperties",
notes = ""
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/inline-additionalProperties",
consumes = { "application/json" }
)
ResponseEntity<Void> testInlineAdditionalProperties(
@ApiParam(value = "request body", required = true ) @Valid @RequestBody Map<String, String> param);
@ApiParam(value = "request body", required = true) @Valid @RequestBody Map<String, String> param
);
/**
@@ -386,21 +411,24 @@ public interface FakeApi {
* @param param2 field2 (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "test json serialization of form data", nickname = "testJsonFormData", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "fake" },
value = "test json serialization of form data",
nickname = "testJsonFormData",
notes = ""
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake/jsonFormData",
consumes = { "application/x-www-form-urlencoded" }
)
ResponseEntity<Void> testJsonFormData(
@ApiParam(value = "field1", required = true) @Valid @RequestPart(value = "param", required = true) String param,
@ApiParam(value = "field2", required = true) @Valid @RequestPart(value = "param2", required = true) String param2);
@ApiParam(value = "field1", required = true) @Valid @RequestPart(value = "param", required = true) String param,
@ApiParam(value = "field2", required = true) @Valid @RequestPart(value = "param2", required = true) String param2
);
/**
@@ -414,26 +442,26 @@ public interface FakeApi {
* @param context (required)
* @return Success (status code 200)
*/
@ApiOperation(value = "", nickname = "testQueryParameterCollectionFormat", notes = "To test the collection format in query parameters", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
@ApiOperation(
tags = { "fake" },
value = "",
nickname = "testQueryParameterCollectionFormat",
notes = "To test the collection format in query parameters"
)
@ApiResponses({
@ApiResponse(code = 200, message = "Success")
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/fake/test-query-parameters"
)
ResponseEntity<Void> testQueryParameterCollectionFormat(@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "pipe", required = true) List<String> pipe
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "ioutil", required = true) List<String> ioutil
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "http", required = true) List<String> http
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "url", required = true) List<String> url
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "context", required = true) List<String> context
);
ResponseEntity<Void> testQueryParameterCollectionFormat(
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "pipe", required = true) List<String> pipe,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "ioutil", required = true) List<String> ioutil,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "http", required = true) List<String> http,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "url", required = true) List<String> url,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "context", required = true) List<String> context
);
/**
@@ -444,27 +472,32 @@ public interface FakeApi {
* @param additionalMetadata Additional data to pass to server (optional)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "uploads an image (required)", nickname = "uploadFileWithRequiredFile", notes = "", response = ModelApiResponse.class, authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = ModelApiResponse.class) })
@ApiOperation(
tags = { "pet" },
value = "uploads an image (required)",
nickname = "uploadFileWithRequiredFile",
notes = "",
response = ModelApiResponse.class,
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = ModelApiResponse.class)
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/{petId}/uploadImageWithRequiredFile",
produces = { "application/json" },
consumes = { "multipart/form-data" }
)
ResponseEntity<ModelApiResponse> uploadFileWithRequiredFile(@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "file to upload") @Valid @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata);
ResponseEntity<ModelApiResponse> uploadFileWithRequiredFile(
@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata
);
}

167
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApiController.java
View File

@@ -50,8 +50,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#createXmlItem
*/
public ResponseEntity<Void> createXmlItem(
@ApiParam(value = "XmlItem Body", required = true ) @Valid @RequestBody XmlItem xmlItem) {
@ApiParam(value = "XmlItem Body", required = true) @Valid @RequestBody XmlItem xmlItem
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -65,8 +65,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#fakeOuterBooleanSerialize
*/
public ResponseEntity<Boolean> fakeOuterBooleanSerialize(
@ApiParam(value = "Input boolean as post body" ) @Valid @RequestBody(required = false) Boolean body) {
@ApiParam(value = "Input boolean as post body") @Valid @RequestBody(required = false) Boolean body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -80,8 +80,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#fakeOuterCompositeSerialize
*/
public ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(
@ApiParam(value = "Input composite as post body" ) @Valid @RequestBody(required = false) OuterComposite body) {
@ApiParam(value = "Input composite as post body") @Valid @RequestBody(required = false) OuterComposite body
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) {
String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }";
@@ -102,8 +102,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#fakeOuterNumberSerialize
*/
public ResponseEntity<BigDecimal> fakeOuterNumberSerialize(
@ApiParam(value = "Input number as post body" ) @Valid @RequestBody(required = false) BigDecimal body) {
@ApiParam(value = "Input number as post body") @Valid @RequestBody(required = false) BigDecimal body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -117,8 +117,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#fakeOuterStringSerialize
*/
public ResponseEntity<String> fakeOuterStringSerialize(
@ApiParam(value = "Input string as post body" ) @Valid @RequestBody(required = false) String body) {
@ApiParam(value = "Input string as post body") @Valid @RequestBody(required = false) String body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -132,8 +132,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#testBodyWithFileSchema
*/
public ResponseEntity<Void> testBodyWithFileSchema(
@ApiParam(value = "", required = true ) @Valid @RequestBody FileSchemaTestClass body) {
@ApiParam(value = "", required = true) @Valid @RequestBody FileSchemaTestClass body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -146,11 +146,10 @@ public class FakeApiController implements FakeApi {
* @return Success (status code 200)
* @see FakeApi#testBodyWithQueryParams
*/
public ResponseEntity<Void> testBodyWithQueryParams(@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "query", required = true) String query
,
@ApiParam(value = "", required = true ) @Valid @RequestBody User body) {
public ResponseEntity<Void> testBodyWithQueryParams(
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "query", required = true) String query,
@ApiParam(value = "", required = true) @Valid @RequestBody User body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -164,8 +163,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#testClientModel
*/
public ResponseEntity<Client> testClientModel(
@ApiParam(value = "client model", required = true ) @Valid @RequestBody Client body) {
@ApiParam(value = "client model", required = true) @Valid @RequestBody Client body
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"client\" : \"client\" }";
@@ -200,34 +199,21 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#testEndpointParameters
*/
public ResponseEntity<Void> testEndpointParameters(
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "number", required = true) BigDecimal number,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "double", required = true) Double _double,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "byte", required = true) byte[] _byte,
@ApiParam(value = "None") @Valid @RequestPart(value = "integer", required = false) Integer integer,
@ApiParam(value = "None") @Valid @RequestPart(value = "int32", required = false) Integer int32,
@ApiParam(value = "None") @Valid @RequestPart(value = "int64", required = false) Long int64,
@ApiParam(value = "None") @Valid @RequestPart(value = "float", required = false) Float _float,
@ApiParam(value = "None") @Valid @RequestPart(value = "string", required = false) String string,
@ApiParam(value = "None") @Valid @RequestPart(value = "binary", required = false) MultipartFile binary,
@ApiParam(value = "None") @Valid @RequestPart(value = "date", required = false) LocalDate date,
@ApiParam(value = "None") @Valid @RequestPart(value = "dateTime", required = false) OffsetDateTime dateTime,
@ApiParam(value = "None") @Valid @RequestPart(value = "password", required = false) String password,
@ApiParam(value = "None") @Valid @RequestPart(value = "callback", required = false) String paramCallback) {
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "number", required = true) BigDecimal number,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "double", required = true) Double _double,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@ApiParam(value = "None", required = true) @Valid @RequestPart(value = "byte", required = true) byte[] _byte,
@ApiParam(value = "None") @Valid @RequestPart(value = "integer", required = false) Integer integer,
@ApiParam(value = "None") @Valid @RequestPart(value = "int32", required = false) Integer int32,
@ApiParam(value = "None") @Valid @RequestPart(value = "int64", required = false) Long int64,
@ApiParam(value = "None") @Valid @RequestPart(value = "float", required = false) Float _float,
@ApiParam(value = "None") @Valid @RequestPart(value = "string", required = false) String string,
@ApiParam(value = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@ApiParam(value = "None") @Valid @RequestPart(value = "date", required = false) @org.springframework.format.annotation.DateTimeFormat(iso = org.springframework.format.annotation.DateTimeFormat.ISO.DATE) LocalDate date,
@ApiParam(value = "None") @Valid @RequestPart(value = "dateTime", required = false) @org.springframework.format.annotation.DateTimeFormat(iso = org.springframework.format.annotation.DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@ApiParam(value = "None") @Valid @RequestPart(value = "password", required = false) String password,
@ApiParam(value = "None") @Valid @RequestPart(value = "callback", required = false) String paramCallback
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -249,22 +235,15 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#testEnumParameters
*/
public ResponseEntity<Void> testEnumParameters(
@ApiParam(value = "Header parameter enum test (string array)", allowableValues = ">, $") @RequestHeader(value = "enum_header_string_array", required = false) List<String> enumHeaderStringArray
,
@ApiParam(value = "Header parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @RequestHeader(value = "enum_header_string", required = false) String enumHeaderString
,@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray
,@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue = "-efg") String enumQueryString
,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger
,@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1.1, -1.2") @Valid @RequestParam(value = "enum_query_double", required = false) Double enumQueryDouble
,
@ApiParam(value = "Form parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestPart(value = "enum_form_string_array", required = false) List<String> enumFormStringArray,
@ApiParam(value = "Form parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestPart(value = "enum_form_string", required = false) String enumFormString) {
@ApiParam(value = "Header parameter enum test (string array)", allowableValues = ">, $") @RequestHeader(value = "enum_header_string_array", required = false) List<String> enumHeaderStringArray,
@ApiParam(value = "Header parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @RequestHeader(value = "enum_header_string", required = false) String enumHeaderString,
@ApiParam(value = "Query parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestParam(value = "enum_query_string_array", required = false) List<String> enumQueryStringArray,
@ApiParam(value = "Query parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestParam(value = "enum_query_string", required = false, defaultValue = "-efg") String enumQueryString,
@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1, -2") @Valid @RequestParam(value = "enum_query_integer", required = false) Integer enumQueryInteger,
@ApiParam(value = "Query parameter enum test (double)", allowableValues = "1.1, -1.2") @Valid @RequestParam(value = "enum_query_double", required = false) Double enumQueryDouble,
@ApiParam(value = "Form parameter enum test (string array)", allowableValues = ">, $") @Valid @RequestPart(value = "enum_form_string_array", required = false) List<String> enumFormStringArray,
@ApiParam(value = "Form parameter enum test (string)", allowableValues = "_abc, -efg, (xyz)", defaultValue = "-efg") @Valid @RequestPart(value = "enum_form_string", required = false) String enumFormString
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -282,19 +261,14 @@ public class FakeApiController implements FakeApi {
* @return Someting wrong (status code 400)
* @see FakeApi#testGroupParameters
*/
public ResponseEntity<Void> testGroupParameters(@NotNull @ApiParam(value = "Required String in group parameters", required = true) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup
,
@ApiParam(value = "Required Boolean in group parameters", required = true) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup
,@NotNull @ApiParam(value = "Required Integer in group parameters", required = true) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group
,@ApiParam(value = "String in group parameters") @Valid @RequestParam(value = "string_group", required = false) Integer stringGroup
,
@ApiParam(value = "Boolean in group parameters") @RequestHeader(value = "boolean_group", required = false) Boolean booleanGroup
,@ApiParam(value = "Integer in group parameters") @Valid @RequestParam(value = "int64_group", required = false) Long int64Group
) {
public ResponseEntity<Void> testGroupParameters(
@NotNull @ApiParam(value = "Required String in group parameters", required = true) @Valid @RequestParam(value = "required_string_group", required = true) Integer requiredStringGroup,
@ApiParam(value = "Required Boolean in group parameters", required = true) @RequestHeader(value = "required_boolean_group", required = true) Boolean requiredBooleanGroup,
@NotNull @ApiParam(value = "Required Integer in group parameters", required = true) @Valid @RequestParam(value = "required_int64_group", required = true) Long requiredInt64Group,
@ApiParam(value = "String in group parameters") @Valid @RequestParam(value = "string_group", required = false) Integer stringGroup,
@ApiParam(value = "Boolean in group parameters") @RequestHeader(value = "boolean_group", required = false) Boolean booleanGroup,
@ApiParam(value = "Integer in group parameters") @Valid @RequestParam(value = "int64_group", required = false) Long int64Group
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -307,8 +281,8 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#testInlineAdditionalProperties
*/
public ResponseEntity<Void> testInlineAdditionalProperties(
@ApiParam(value = "request body", required = true ) @Valid @RequestBody Map<String, String> param) {
@ApiParam(value = "request body", required = true) @Valid @RequestBody Map<String, String> param
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -322,10 +296,9 @@ public class FakeApiController implements FakeApi {
* @see FakeApi#testJsonFormData
*/
public ResponseEntity<Void> testJsonFormData(
@ApiParam(value = "field1", required = true) @Valid @RequestPart(value = "param", required = true) String param,
@ApiParam(value = "field2", required = true) @Valid @RequestPart(value = "param2", required = true) String param2) {
@ApiParam(value = "field1", required = true) @Valid @RequestPart(value = "param", required = true) String param,
@ApiParam(value = "field2", required = true) @Valid @RequestPart(value = "param2", required = true) String param2
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -342,17 +315,13 @@ public class FakeApiController implements FakeApi {
* @return Success (status code 200)
* @see FakeApi#testQueryParameterCollectionFormat
*/
public ResponseEntity<Void> testQueryParameterCollectionFormat(@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "pipe", required = true) List<String> pipe
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "ioutil", required = true) List<String> ioutil
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "http", required = true) List<String> http
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "url", required = true) List<String> url
,@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "context", required = true) List<String> context
) {
public ResponseEntity<Void> testQueryParameterCollectionFormat(
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "pipe", required = true) List<String> pipe,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "ioutil", required = true) List<String> ioutil,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "http", required = true) List<String> http,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "url", required = true) List<String> url,
@NotNull @ApiParam(value = "", required = true) @Valid @RequestParam(value = "context", required = true) List<String> context
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -366,13 +335,11 @@ public class FakeApiController implements FakeApi {
* @return successful operation (status code 200)
* @see FakeApi#uploadFileWithRequiredFile
*/
public ResponseEntity<ModelApiResponse> uploadFileWithRequiredFile(@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "file to upload") @Valid @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata) {
public ResponseEntity<ModelApiResponse> uploadFileWithRequiredFile(
@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "file to upload", required = true) @RequestPart(value = "requiredFile", required = true) MultipartFile requiredFile,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"code\" : 0, \"type\" : \"type\", \"message\" : \"message\" }";

25
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeClassnameTestApi.java
View File

@@ -28,14 +28,19 @@ public interface FakeClassnameTestApi {
* @param body client model (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "To test class name in snake case", nickname = "testClassname", notes = "To test class name in snake case", response = Client.class, authorizations = {
@Authorization(value = "api_key_query")
}, tags={ "fake_classname_tags 123#$%^", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
@ApiOperation(
tags = { "fake_classname_tags 123#$%^" },
value = "To test class name in snake case",
nickname = "testClassname",
notes = "To test class name in snake case",
response = Client.class,
authorizations = {
@Authorization(value = "api_key_query")
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Client.class)
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/fake_classname_test",
@@ -43,7 +48,7 @@ public interface FakeClassnameTestApi {
consumes = { "application/json" }
)
ResponseEntity<Client> testClassname(
@ApiParam(value = "client model", required = true ) @Valid @RequestBody Client body);
@ApiParam(value = "client model", required = true) @Valid @RequestBody Client body
);
}

4
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeClassnameTestApiController.java
View File

@@ -41,8 +41,8 @@ public class FakeClassnameTestApiController implements FakeClassnameTestApi {
* @see FakeClassnameTestApi#testClassname
*/
public ResponseEntity<Client> testClassname(
@ApiParam(value = "client model", required = true ) @Valid @RequestBody Client body) {
@ApiParam(value = "client model", required = true) @Valid @RequestBody Client body
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"client\" : \"client\" }";

262
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java
View File

@@ -30,25 +30,30 @@ public interface PetApi {
* @return successful operation (status code 200)
* or Invalid input (status code 405)
*/
@ApiOperation(value = "Add a new pet to the store", nickname = "addPet", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiOperation(
tags = { "pet" },
value = "Add a new pet to the store",
nickname = "addPet",
notes = "",
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation"),
@ApiResponse(code = 405, message = "Invalid input") })
@ApiResponse(code = 405, message = "Invalid input")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet",
consumes = { "application/json", "application/xml" }
)
ResponseEntity<Void> addPet(
@ApiParam(value = "Pet object that needs to be added to the store", required = true ) @Valid @RequestBody Pet body);
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet body
);
/**
@@ -59,26 +64,30 @@ public interface PetApi {
* @return successful operation (status code 200)
* or Invalid pet value (status code 400)
*/
@ApiOperation(value = "Deletes a pet", nickname = "deletePet", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiOperation(
tags = { "pet" },
value = "Deletes a pet",
nickname = "deletePet",
notes = "",
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation"),
@ApiResponse(code = 400, message = "Invalid pet value") })
@ApiResponse(code = 400, message = "Invalid pet value")
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/pet/{petId}"
)
ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "") @RequestHeader(value = "api_key", required = false) String apiKey
);
ResponseEntity<Void> deletePet(
@ApiParam(value = "Pet id to delete", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "") @RequestHeader(value = "api_key", required = false) String apiKey
);
/**
@@ -89,25 +98,32 @@ public interface PetApi {
* @return successful operation (status code 200)
* or Invalid status value (status code 400)
*/
@ApiOperation(value = "Finds Pets by status", nickname = "findPetsByStatus", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiOperation(
tags = { "pet" },
value = "Finds Pets by status",
nickname = "findPetsByStatus",
notes = "Multiple status values can be provided with comma separated strings",
response = Pet.class,
responseContainer = "List",
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "List"),
@ApiResponse(code = 400, message = "Invalid status value") })
@ApiResponse(code = 400, message = "Invalid status value")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/findByStatus",
produces = { "application/xml", "application/json" }
)
ResponseEntity<List<Pet>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List<String> status
);
ResponseEntity<List<Pet>> findPetsByStatus(
@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List<String> status
);
/**
@@ -119,25 +135,32 @@ public interface PetApi {
* or Invalid tag value (status code 400)
* @deprecated
*/
@ApiOperation(value = "Finds Pets by tags", nickname = "findPetsByTags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "Set", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiOperation(
tags = { "pet" },
value = "Finds Pets by tags",
nickname = "findPetsByTags",
notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
response = Pet.class,
responseContainer = "Set",
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Pet.class, responseContainer = "Set"),
@ApiResponse(code = 400, message = "Invalid tag value") })
@ApiResponse(code = 400, message = "Invalid tag value")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/findByTags",
produces = { "application/xml", "application/json" }
)
ResponseEntity<Set<Pet>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) Set<String> tags
);
ResponseEntity<Set<Pet>> findPetsByTags(
@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) Set<String> tags
);
/**
@@ -149,26 +172,29 @@ public interface PetApi {
* or Invalid ID supplied (status code 400)
* or Pet not found (status code 404)
*/
@ApiOperation(value = "Find pet by ID", nickname = "getPetById", notes = "Returns a single pet", response = Pet.class, authorizations = {
@Authorization(value = "api_key")
}, tags={ "pet", })
@ApiResponses(value = {
@ApiOperation(
tags = { "pet" },
value = "Find pet by ID",
nickname = "getPetById",
notes = "Returns a single pet",
response = Pet.class,
authorizations = {
@Authorization(value = "api_key")
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Pet.class),
@ApiResponse(code = 400, message = "Invalid ID supplied"),
@ApiResponse(code = 404, message = "Pet not found") })
@ApiResponse(code = 404, message = "Pet not found")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/{petId}",
produces = { "application/xml", "application/json" }
)
ResponseEntity<Pet> getPetById(@ApiParam(value = "ID of pet to return", required = true) @PathVariable("petId") Long petId
);
ResponseEntity<Pet> getPetById(
@ApiParam(value = "ID of pet to return", required = true) @PathVariable("petId") Long petId
);
/**
@@ -180,29 +206,32 @@ public interface PetApi {
* or Pet not found (status code 404)
* or Validation exception (status code 405)
*/
@ApiOperation(value = "Update an existing pet", nickname = "updatePet", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiOperation(
tags = { "pet" },
value = "Update an existing pet",
nickname = "updatePet",
notes = "",
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation"),
@ApiResponse(code = 400, message = "Invalid ID supplied"),
@ApiResponse(code = 404, message = "Pet not found"),
@ApiResponse(code = 405, message = "Validation exception") })
@ApiResponse(code = 405, message = "Validation exception")
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/pet",
consumes = { "application/json", "application/xml" }
)
ResponseEntity<Void> updatePet(
@ApiParam(value = "Pet object that needs to be added to the store", required = true ) @Valid @RequestBody Pet body);
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet body
);
/**
@@ -213,27 +242,31 @@ public interface PetApi {
* @param status Updated status of the pet (optional)
* @return Invalid input (status code 405)
*/
@ApiOperation(value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiResponse(code = 405, message = "Invalid input") })
@ApiOperation(
tags = { "pet" },
value = "Updates a pet in the store with form data",
nickname = "updatePetWithForm",
notes = "",
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 405, message = "Invalid input")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet/{petId}",
consumes = { "application/x-www-form-urlencoded" }
)
ResponseEntity<Void> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "Updated name of the pet") @Valid @RequestPart(value = "name", required = false) String name,
@ApiParam(value = "Updated status of the pet") @Valid @RequestPart(value = "status", required = false) String status);
ResponseEntity<Void> updatePetWithForm(
@ApiParam(value = "ID of pet that needs to be updated", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "Updated name of the pet") @Valid @RequestPart(value = "name", required = false) String name,
@ApiParam(value = "Updated status of the pet") @Valid @RequestPart(value = "status", required = false) String status
);
/**
@@ -244,27 +277,32 @@ public interface PetApi {
* @param file file to upload (optional)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "uploads an image", nickname = "uploadFile", notes = "", response = ModelApiResponse.class, authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets") })
}, tags={ "pet", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = ModelApiResponse.class) })
@ApiOperation(
tags = { "pet" },
value = "uploads an image",
nickname = "uploadFile",
notes = "",
response = ModelApiResponse.class,
authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@AuthorizationScope(scope = "read:pets", description = "read your pets")
})
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = ModelApiResponse.class)
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet/{petId}/uploadImage",
produces = { "application/json" },
consumes = { "multipart/form-data" }
)
ResponseEntity<ModelApiResponse> uploadFile(@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata,
@ApiParam(value = "file to upload") @Valid @RequestPart(value = "file", required = false) MultipartFile file);
ResponseEntity<ModelApiResponse> uploadFile(
@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata,
@ApiParam(value = "file to upload") @RequestPart(value = "file", required = false) MultipartFile file
);
}

59
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApiController.java
View File

@@ -43,8 +43,8 @@ public class PetApiController implements PetApi {
* @see PetApi#addPet
*/
public ResponseEntity<Void> addPet(
@ApiParam(value = "Pet object that needs to be added to the store", required = true ) @Valid @RequestBody Pet body) {
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -58,11 +58,10 @@ public class PetApiController implements PetApi {
* or Invalid pet value (status code 400)
* @see PetApi#deletePet
*/
public ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "") @RequestHeader(value = "api_key", required = false) String apiKey
) {
public ResponseEntity<Void> deletePet(
@ApiParam(value = "Pet id to delete", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "") @RequestHeader(value = "api_key", required = false) String apiKey
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -76,9 +75,9 @@ public class PetApiController implements PetApi {
* or Invalid status value (status code 400)
* @see PetApi#findPetsByStatus
*/
public ResponseEntity<List<Pet>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List<String> status
) {
public ResponseEntity<List<Pet>> findPetsByStatus(
@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List<String> status
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" }";
@@ -105,9 +104,9 @@ public class PetApiController implements PetApi {
* @deprecated
* @see PetApi#findPetsByTags
*/
public ResponseEntity<Set<Pet>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) Set<String> tags
) {
public ResponseEntity<Set<Pet>> findPetsByTags(
@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) Set<String> tags
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" }";
@@ -134,9 +133,9 @@ public class PetApiController implements PetApi {
* or Pet not found (status code 404)
* @see PetApi#getPetById
*/
public ResponseEntity<Pet> getPetById(@ApiParam(value = "ID of pet to return", required = true) @PathVariable("petId") Long petId
) {
public ResponseEntity<Pet> getPetById(
@ApiParam(value = "ID of pet to return", required = true) @PathVariable("petId") Long petId
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" }";
@@ -164,8 +163,8 @@ public class PetApiController implements PetApi {
* @see PetApi#updatePet
*/
public ResponseEntity<Void> updatePet(
@ApiParam(value = "Pet object that needs to be added to the store", required = true ) @Valid @RequestBody Pet body) {
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -179,13 +178,11 @@ public class PetApiController implements PetApi {
* @return Invalid input (status code 405)
* @see PetApi#updatePetWithForm
*/
public ResponseEntity<Void> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "Updated name of the pet") @Valid @RequestPart(value = "name", required = false) String name,
@ApiParam(value = "Updated status of the pet") @Valid @RequestPart(value = "status", required = false) String status) {
public ResponseEntity<Void> updatePetWithForm(
@ApiParam(value = "ID of pet that needs to be updated", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "Updated name of the pet") @Valid @RequestPart(value = "name", required = false) String name,
@ApiParam(value = "Updated status of the pet") @Valid @RequestPart(value = "status", required = false) String status
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -199,13 +196,11 @@ public class PetApiController implements PetApi {
* @return successful operation (status code 200)
* @see PetApi#uploadFile
*/
public ResponseEntity<ModelApiResponse> uploadFile(@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId
,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata,
@ApiParam(value = "file to upload") @Valid @RequestPart(value = "file", required = false) MultipartFile file) {
public ResponseEntity<ModelApiResponse> uploadFile(
@ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId,
@ApiParam(value = "Additional data to pass to server") @Valid @RequestPart(value = "additionalMetadata", required = false) String additionalMetadata,
@ApiParam(value = "file to upload") @RequestPart(value = "file", required = false) MultipartFile file
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"code\" : 0, \"type\" : \"type\", \"message\" : \"message\" }";

90
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java
View File

@@ -30,20 +30,23 @@ public interface StoreApi {
* @return Invalid ID supplied (status code 400)
* or Order not found (status code 404)
*/
@ApiOperation(value = "Delete purchase order by ID", nickname = "deleteOrder", notes = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", tags={ "store", })
@ApiResponses(value = {
@ApiOperation(
tags = { "store" },
value = "Delete purchase order by ID",
nickname = "deleteOrder",
notes = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors"
)
@ApiResponses({
@ApiResponse(code = 400, message = "Invalid ID supplied"),
@ApiResponse(code = 404, message = "Order not found") })
@ApiResponse(code = 404, message = "Order not found")
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/store/order/{order_id}"
)
ResponseEntity<Void> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted", required = true) @PathVariable("order_id") String orderId
);
ResponseEntity<Void> deleteOrder(
@ApiParam(value = "ID of the order that needs to be deleted", required = true) @PathVariable("order_id") String orderId
);
/**
@@ -52,20 +55,28 @@ public interface StoreApi {
*
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Returns pet inventories by status", nickname = "getInventory", notes = "Returns a map of status codes to quantities", response = Integer.class, responseContainer = "Map", authorizations = {
@Authorization(value = "api_key")
}, tags={ "store", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Map.class, responseContainer = "Map") })
@ApiOperation(
tags = { "store" },
value = "Returns pet inventories by status",
nickname = "getInventory",
notes = "Returns a map of status codes to quantities",
response = Integer.class,
responseContainer = "Map",
authorizations = {
@Authorization(value = "api_key")
}
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Map.class, responseContainer = "Map")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/store/inventory",
produces = { "application/json" }
)
ResponseEntity<Map<String, Integer>> getInventory();
ResponseEntity<Map<String, Integer>> getInventory(
);
/**
@@ -77,23 +88,26 @@ public interface StoreApi {
* or Invalid ID supplied (status code 400)
* or Order not found (status code 404)
*/
@ApiOperation(value = "Find purchase order by ID", nickname = "getOrderById", notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions", response = Order.class, tags={ "store", })
@ApiResponses(value = {
@ApiOperation(
tags = { "store" },
value = "Find purchase order by ID",
nickname = "getOrderById",
notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
response = Order.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Order.class),
@ApiResponse(code = 400, message = "Invalid ID supplied"),
@ApiResponse(code = 404, message = "Order not found") })
@ApiResponse(code = 404, message = "Order not found")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/store/order/{order_id}",
produces = { "application/xml", "application/json" }
)
ResponseEntity<Order> getOrderById(@Min(1L) @Max(5L) @ApiParam(value = "ID of pet that needs to be fetched", required = true) @PathVariable("order_id") Long orderId
);
ResponseEntity<Order> getOrderById(
@Min(1L) @Max(5L) @ApiParam(value = "ID of pet that needs to be fetched", required = true) @PathVariable("order_id") Long orderId
);
/**
@@ -103,20 +117,24 @@ public interface StoreApi {
* @return successful operation (status code 200)
* or Invalid Order (status code 400)
*/
@ApiOperation(value = "Place an order for a pet", nickname = "placeOrder", notes = "", response = Order.class, tags={ "store", })
@ApiResponses(value = {
@ApiOperation(
tags = { "store" },
value = "Place an order for a pet",
nickname = "placeOrder",
notes = "",
response = Order.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = Order.class),
@ApiResponse(code = 400, message = "Invalid Order") })
@ApiResponse(code = 400, message = "Invalid Order")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/store/order",
produces = { "application/xml", "application/json" }
)
ResponseEntity<Order> placeOrder(
@ApiParam(value = "order placed for purchasing the pet", required = true ) @Valid @RequestBody Order body);
@ApiParam(value = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order body
);
}

20
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApiController.java
View File

@@ -42,9 +42,9 @@ public class StoreApiController implements StoreApi {
* or Order not found (status code 404)
* @see StoreApi#deleteOrder
*/
public ResponseEntity<Void> deleteOrder(@ApiParam(value = "ID of the order that needs to be deleted", required = true) @PathVariable("order_id") String orderId
) {
public ResponseEntity<Void> deleteOrder(
@ApiParam(value = "ID of the order that needs to be deleted", required = true) @PathVariable("order_id") String orderId
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -56,7 +56,9 @@ public class StoreApiController implements StoreApi {
* @return successful operation (status code 200)
* @see StoreApi#getInventory
*/
public ResponseEntity<Map<String, Integer>> getInventory() {
public ResponseEntity<Map<String, Integer>> getInventory(
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -71,9 +73,9 @@ public class StoreApiController implements StoreApi {
* or Order not found (status code 404)
* @see StoreApi#getOrderById
*/
public ResponseEntity<Order> getOrderById(@Min(1L) @Max(5L) @ApiParam(value = "ID of pet that needs to be fetched", required = true) @PathVariable("order_id") Long orderId
) {
public ResponseEntity<Order> getOrderById(
@Min(1L) @Max(5L) @ApiParam(value = "ID of pet that needs to be fetched", required = true) @PathVariable("order_id") Long orderId
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"petId\" : 6, \"quantity\" : 1, \"id\" : 0, \"shipDate\" : \"2000-01-23T04:56:07.000+00:00\", \"complete\" : false, \"status\" : \"placed\" }";
@@ -99,8 +101,8 @@ public class StoreApiController implements StoreApi {
* @see StoreApi#placeOrder
*/
public ResponseEntity<Order> placeOrder(
@ApiParam(value = "order placed for purchasing the pet", required = true ) @Valid @RequestBody Order body) {
@ApiParam(value = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order body
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"petId\" : 6, \"quantity\" : 1, \"id\" : 0, \"shipDate\" : \"2000-01-23T04:56:07.000+00:00\", \"complete\" : false, \"status\" : \"placed\" }";

165
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java
View File

@@ -30,18 +30,22 @@ public interface UserApi {
* @param body Created user object (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Create user", nickname = "createUser", notes = "This can only be done by the logged in user.", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "user" },
value = "Create user",
nickname = "createUser",
notes = "This can only be done by the logged in user."
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user"
)
ResponseEntity<Void> createUser(
@ApiParam(value = "Created user object", required = true ) @Valid @RequestBody User body);
@ApiParam(value = "Created user object", required = true) @Valid @RequestBody User body
);
/**
@@ -50,18 +54,22 @@ public interface UserApi {
* @param body List of user object (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "user" },
value = "Creates list of users with given input array",
nickname = "createUsersWithArrayInput",
notes = ""
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user/createWithArray"
)
ResponseEntity<Void> createUsersWithArrayInput(
@ApiParam(value = "List of user object", required = true ) @Valid @RequestBody List<User> body);
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<User> body
);
/**
@@ -70,18 +78,22 @@ public interface UserApi {
* @param body List of user object (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "user" },
value = "Creates list of users with given input array",
nickname = "createUsersWithListInput",
notes = ""
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user/createWithList"
)
ResponseEntity<Void> createUsersWithListInput(
@ApiParam(value = "List of user object", required = true ) @Valid @RequestBody List<User> body);
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<User> body
);
/**
@@ -92,20 +104,23 @@ public interface UserApi {
* @return Invalid username supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", })
@ApiResponses(value = {
@ApiOperation(
tags = { "user" },
value = "Delete user",
nickname = "deleteUser",
notes = "This can only be done by the logged in user."
)
@ApiResponses({
@ApiResponse(code = 400, message = "Invalid username supplied"),
@ApiResponse(code = 404, message = "User not found") })
@ApiResponse(code = 404, message = "User not found")
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/user/{username}"
)
ResponseEntity<Void> deleteUser(@ApiParam(value = "The name that needs to be deleted", required = true) @PathVariable("username") String username
);
ResponseEntity<Void> deleteUser(
@ApiParam(value = "The name that needs to be deleted", required = true) @PathVariable("username") String username
);
/**
@@ -116,23 +131,26 @@ public interface UserApi {
* or Invalid username supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", })
@ApiResponses(value = {
@ApiOperation(
tags = { "user" },
value = "Get user by user name",
nickname = "getUserByName",
notes = "",
response = User.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = User.class),
@ApiResponse(code = 400, message = "Invalid username supplied"),
@ApiResponse(code = 404, message = "User not found") })
@ApiResponse(code = 404, message = "User not found")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/{username}",
produces = { "application/xml", "application/json" }
)
ResponseEntity<User> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing.", required = true) @PathVariable("username") String username
);
ResponseEntity<User> getUserByName(
@ApiParam(value = "The name that needs to be fetched. Use user1 for testing.", required = true) @PathVariable("username") String username
);
/**
@@ -143,23 +161,26 @@ public interface UserApi {
* @return successful operation (status code 200)
* or Invalid username/password supplied (status code 400)
*/
@ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", })
@ApiResponses(value = {
@ApiOperation(
tags = { "user" },
value = "Logs user into the system",
nickname = "loginUser",
notes = "",
response = String.class
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation", response = String.class),
@ApiResponse(code = 400, message = "Invalid username/password supplied") })
@ApiResponse(code = 400, message = "Invalid username/password supplied")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/login",
produces = { "application/xml", "application/json" }
)
ResponseEntity<String> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username
,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password
);
ResponseEntity<String> loginUser(
@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,
@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password
);
/**
@@ -167,16 +188,22 @@ public interface UserApi {
*
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@ApiOperation(
tags = { "user" },
value = "Logs out current logged in user session",
nickname = "logoutUser",
notes = ""
)
@ApiResponses({
@ApiResponse(code = 200, message = "successful operation")
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/logout"
)
ResponseEntity<Void> logoutUser();
ResponseEntity<Void> logoutUser(
);
/**
@@ -188,21 +215,23 @@ public interface UserApi {
* @return Invalid user supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Updated user", nickname = "updateUser", notes = "This can only be done by the logged in user.", tags={ "user", })
@ApiResponses(value = {
@ApiOperation(
tags = { "user" },
value = "Updated user",
nickname = "updateUser",
notes = "This can only be done by the logged in user."
)
@ApiResponses({
@ApiResponse(code = 400, message = "Invalid user supplied"),
@ApiResponse(code = 404, message = "User not found") })
@ApiResponse(code = 404, message = "User not found")
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/user/{username}"
)
ResponseEntity<Void> updateUser(@ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username
,
@ApiParam(value = "Updated user object", required = true ) @Valid @RequestBody User body);
ResponseEntity<Void> updateUser(
@ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username,
@ApiParam(value = "Updated user object", required = true) @Valid @RequestBody User body
);
}

46
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApiController.java
View File

@@ -43,8 +43,8 @@ public class UserApiController implements UserApi {
* @see UserApi#createUser
*/
public ResponseEntity<Void> createUser(
@ApiParam(value = "Created user object", required = true ) @Valid @RequestBody User body) {
@ApiParam(value = "Created user object", required = true) @Valid @RequestBody User body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -57,8 +57,8 @@ public class UserApiController implements UserApi {
* @see UserApi#createUsersWithArrayInput
*/
public ResponseEntity<Void> createUsersWithArrayInput(
@ApiParam(value = "List of user object", required = true ) @Valid @RequestBody List<User> body) {
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<User> body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -71,8 +71,8 @@ public class UserApiController implements UserApi {
* @see UserApi#createUsersWithListInput
*/
public ResponseEntity<Void> createUsersWithListInput(
@ApiParam(value = "List of user object", required = true ) @Valid @RequestBody List<User> body) {
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<User> body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -86,9 +86,9 @@ public class UserApiController implements UserApi {
* or User not found (status code 404)
* @see UserApi#deleteUser
*/
public ResponseEntity<Void> deleteUser(@ApiParam(value = "The name that needs to be deleted", required = true) @PathVariable("username") String username
) {
public ResponseEntity<Void> deleteUser(
@ApiParam(value = "The name that needs to be deleted", required = true) @PathVariable("username") String username
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -102,9 +102,9 @@ public class UserApiController implements UserApi {
* or User not found (status code 404)
* @see UserApi#getUserByName
*/
public ResponseEntity<User> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing.", required = true) @PathVariable("username") String username
) {
public ResponseEntity<User> getUserByName(
@ApiParam(value = "The name that needs to be fetched. Use user1 for testing.", required = true) @PathVariable("username") String username
) {
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
String exampleString = "{ \"firstName\" : \"firstName\", \"lastName\" : \"lastName\", \"password\" : \"password\", \"userStatus\" : 6, \"phone\" : \"phone\", \"id\" : 0, \"email\" : \"email\", \"username\" : \"username\" }";
@@ -130,11 +130,10 @@ public class UserApiController implements UserApi {
* or Invalid username/password supplied (status code 400)
* @see UserApi#loginUser
*/
public ResponseEntity<String> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username
,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password
) {
public ResponseEntity<String> loginUser(
@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,
@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -145,7 +144,9 @@ public class UserApiController implements UserApi {
* @return successful operation (status code 200)
* @see UserApi#logoutUser
*/
public ResponseEntity<Void> logoutUser() {
public ResponseEntity<Void> logoutUser(
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
@@ -160,11 +161,10 @@ public class UserApiController implements UserApi {
* or User not found (status code 404)
* @see UserApi#updateUser
*/
public ResponseEntity<Void> updateUser(@ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username
,
@ApiParam(value = "Updated user object", required = true ) @Valid @RequestBody User body) {
public ResponseEntity<Void> updateUser(
@ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username,
@ApiParam(value = "Updated user object", required = true) @Valid @RequestBody User body
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}