Fix of #3371, to have a correct @ApiResponse's response type.

@ApiResponse's 'response' property now refers to its relative 'baseType', if defined.
swagger-api · Feb 15, 2017 · 09e2bbe · 09e2bbe
1 parent 7aebcfa
commit 09e2bbe
Show file tree

Hide file tree

Showing 23 changed files with 266 additions and 148 deletions.
diff --git a/modules/swagger-codegen/src/main/resources/JavaSpring/api.mustache b/modules/swagger-codegen/src/main/resources/JavaSpring/api.mustache
@@ -36,7 +36,7 @@ public interface {{classname}} {
  {{/hasMore}}{{/authMethods}}
  }{{/hasAuthMethods}}, tags={ {{#vendorExtensions.x-tags}}"{{tag}}",{{/vendorExtensions.x-tags}} })
  @ApiResponses(value = { {{#responses}}
- @ApiResponse(code = {{{code}}}, message = "{{{message}}}", response = {{{returnType}}}.class){{#hasMore}},{{/hasMore}}{{/responses}} })
+ @ApiResponse(code = {{{code}}}, message = "{{{message}}}"{{#baseType}}, response = {{{baseType}}}.class{{/baseType}}){{#hasMore}},{{/hasMore}}{{/responses}} })
  @RequestMapping(value = "{{{path}}}",{{#singleContentTypes}}
  produces = "{{{vendorExtensions.x-accepts}}}",
  consumes = "{{{vendorExtensions.x-contentType}}}",{{/singleContentTypes}}{{^singleContentTypes}}{{#hasProduces}}

diff --git a/samples/client/petstore/spring-cloud/src/main/java/io/swagger/api/PetApi.java b/samples/client/petstore/spring-cloud/src/main/java/io/swagger/api/PetApi.java
@@ -28,7 +28,7 @@ public interface PetApi {
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
+ @ApiResponse(code = 405, message = "Invalid input") })
  @RequestMapping(value = "/pet",
  produces = "application/json",
  consumes = "application/json",
@@ -43,7 +43,7 @@ public interface PetApi {
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid pet value") })
  @RequestMapping(value = "/pet/{petId}",
  produces = "application/json",
  consumes = "application/json",
@@ -60,7 +60,7 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<Void>> deletePet(@ApiParam(val
  }, tags={ "pet", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
- @ApiResponse(code = 400, message = "Invalid status value", response = Pet.class) })
+ @ApiResponse(code = 400, message = "Invalid status value") })
  @RequestMapping(value = "/pet/findByStatus",
  produces = "application/json",
  consumes = "application/json",
@@ -76,7 +76,7 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<Void>> deletePet(@ApiParam(val
  }, tags={ "pet", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
- @ApiResponse(code = 400, message = "Invalid tag value", response = Pet.class) })
+ @ApiResponse(code = 400, message = "Invalid tag value") })
  @RequestMapping(value = "/pet/findByTags",
  produces = "application/json",
  consumes = "application/json",
@@ -89,8 +89,8 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<Void>> deletePet(@ApiParam(val
  }, tags={ "pet", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Pet.class),
- @ApiResponse(code = 404, message = "Pet not found", response = Pet.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Pet not found") })
  @RequestMapping(value = "/pet/{petId}",
  produces = "application/json",
  consumes = "application/json",
@@ -105,9 +105,9 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<Void>> deletePet(@ApiParam(val
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
- @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
- @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Pet not found"),
+ @ApiResponse(code = 405, message = "Validation exception") })
  @RequestMapping(value = "/pet",
  produces = "application/json",
  consumes = "application/json",
@@ -122,7 +122,7 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<Void>> deletePet(@ApiParam(val
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
+ @ApiResponse(code = 405, message = "Invalid input") })
  @RequestMapping(value = "/pet/{petId}",
  produces = "application/json",
  consumes = "application/x-www-form-urlencoded",

diff --git a/samples/client/petstore/spring-cloud/src/main/java/io/swagger/api/StoreApi.java b/samples/client/petstore/spring-cloud/src/main/java/io/swagger/api/StoreApi.java
@@ -22,8 +22,8 @@ public interface 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", response = Void.class, tags={ "store", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
- @ApiResponse(code = 404, message = "Order not found", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Order not found") })
  @RequestMapping(value = "/store/order/{orderId}",
  produces = "application/json",
  consumes = "application/json",
@@ -35,7 +35,7 @@ public interface StoreApi {
  @Authorization(value = "api_key")
  }, tags={ "store", })
  @ApiResponses(value = { 
- @ApiResponse(code = 200, message = "successful operation", response = Integer.class) })
+ @ApiResponse(code = 200, message = "successful operation", response = Map.class) })
  @RequestMapping(value = "/store/inventory",
  produces = "application/json",
  consumes = "application/json",
@@ -46,8 +46,8 @@ public interface 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", response = Order.class, tags={ "store", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Order.class),
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Order.class),
- @ApiResponse(code = 404, message = "Order not found", response = Order.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Order not found") })
  @RequestMapping(value = "/store/order/{orderId}",
  produces = "application/json",
  consumes = "application/json",
@@ -58,7 +58,7 @@ public interface StoreApi {
  @ApiOperation(value = "Place an order for a pet", notes = "", response = Order.class, tags={ "store", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Order.class),
- @ApiResponse(code = 400, message = "Invalid Order", response = Order.class) })
+ @ApiResponse(code = 400, message = "Invalid Order") })
  @RequestMapping(value = "/store/order",
  produces = "application/json",
  consumes = "application/json",

diff --git a/samples/client/petstore/spring-cloud/src/main/java/io/swagger/api/UserApi.java b/samples/client/petstore/spring-cloud/src/main/java/io/swagger/api/UserApi.java
@@ -22,7 +22,7 @@ public interface UserApi {
 
  @ApiOperation(value = "Create user", notes = "This can only be done by the logged in user.", response = Void.class, tags={ "user", })
  @ApiResponses(value = { 
- @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
+ @ApiResponse(code = 200, message = "successful operation") })
  @RequestMapping(value = "/user",
  produces = "application/json",
  consumes = "application/json",
@@ -32,7 +32,7 @@ public interface UserApi {
 
  @ApiOperation(value = "Creates list of users with given input array", notes = "", response = Void.class, tags={ "user", })
  @ApiResponses(value = { 
- @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
+ @ApiResponse(code = 200, message = "successful operation") })
  @RequestMapping(value = "/user/createWithArray",
  produces = "application/json",
  consumes = "application/json",
@@ -42,7 +42,7 @@ public interface UserApi {
 
  @ApiOperation(value = "Creates list of users with given input array", notes = "", response = Void.class, tags={ "user", })
  @ApiResponses(value = { 
- @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
+ @ApiResponse(code = 200, message = "successful operation") })
  @RequestMapping(value = "/user/createWithList",
  produces = "application/json",
  consumes = "application/json",
@@ -52,8 +52,8 @@ public interface UserApi {
 
  @ApiOperation(value = "Delete user", notes = "This can only be done by the logged in user.", response = Void.class, tags={ "user", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid username supplied", response = Void.class),
- @ApiResponse(code = 404, message = "User not found", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid username supplied"),
+ @ApiResponse(code = 404, message = "User not found") })
  @RequestMapping(value = "/user/{username}",
  produces = "application/json",
  consumes = "application/json",
@@ -64,8 +64,8 @@ public interface UserApi {
  @ApiOperation(value = "Get user by user name", notes = "", response = User.class, tags={ "user", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = User.class),
- @ApiResponse(code = 400, message = "Invalid username supplied", response = User.class),
- @ApiResponse(code = 404, message = "User not found", response = User.class) })
+ @ApiResponse(code = 400, message = "Invalid username supplied"),
+ @ApiResponse(code = 404, message = "User not found") })
  @RequestMapping(value = "/user/{username}",
  produces = "application/json",
  consumes = "application/json",
@@ -76,7 +76,7 @@ public interface UserApi {
  @ApiOperation(value = "Logs user into the system", notes = "", response = String.class, tags={ "user", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = String.class),
- @ApiResponse(code = 400, message = "Invalid username/password supplied", response = String.class) })
+ @ApiResponse(code = 400, message = "Invalid username/password supplied") })
  @RequestMapping(value = "/user/login",
  produces = "application/json",
  consumes = "application/json",
@@ -87,7 +87,7 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<String>> loginUser(@ApiParam(v
 
  @ApiOperation(value = "Logs out current logged in user session", notes = "", response = Void.class, tags={ "user", })
  @ApiResponses(value = { 
- @ApiResponse(code = 200, message = "successful operation", response = Void.class) })
+ @ApiResponse(code = 200, message = "successful operation") })
  @RequestMapping(value = "/user/logout",
  produces = "application/json",
  consumes = "application/json",
@@ -97,8 +97,8 @@ com.netflix.hystrix.HystrixCommand<ResponseEntity<String>> loginUser(@ApiParam(v
 
  @ApiOperation(value = "Updated user", notes = "This can only be done by the logged in user.", response = Void.class, tags={ "user", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid user supplied", response = Void.class),
- @ApiResponse(code = 404, message = "User not found", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid user supplied"),
+ @ApiResponse(code = 404, message = "User not found") })
  @RequestMapping(value = "/user/{username}",
  produces = "application/json",
  consumes = "application/json",

diff --git a/samples/client/petstore/spring-stubs/src/main/java/io/swagger/api/PetApi.java b/samples/client/petstore/spring-stubs/src/main/java/io/swagger/api/PetApi.java
@@ -28,7 +28,7 @@ public interface PetApi {
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
+ @ApiResponse(code = 405, message = "Invalid input") })
  @RequestMapping(value = "/pet",
  produces = "application/json",
  consumes = "application/json",
@@ -43,7 +43,7 @@ public interface PetApi {
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid pet value", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid pet value") })
  @RequestMapping(value = "/pet/{petId}",
  produces = "application/json",
  consumes = "application/json",
@@ -60,7 +60,7 @@ ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete",required=tru
  }, tags={ "pet", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
- @ApiResponse(code = 400, message = "Invalid status value", response = Pet.class) })
+ @ApiResponse(code = 400, message = "Invalid status value") })
  @RequestMapping(value = "/pet/findByStatus",
  produces = "application/json",
  consumes = "application/json",
@@ -76,7 +76,7 @@ ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete",required=tru
  }, tags={ "pet", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
- @ApiResponse(code = 400, message = "Invalid tag value", response = Pet.class) })
+ @ApiResponse(code = 400, message = "Invalid tag value") })
  @RequestMapping(value = "/pet/findByTags",
  produces = "application/json",
  consumes = "application/json",
@@ -89,8 +89,8 @@ ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete",required=tru
  }, tags={ "pet", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Pet.class),
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Pet.class),
- @ApiResponse(code = 404, message = "Pet not found", response = Pet.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Pet not found") })
  @RequestMapping(value = "/pet/{petId}",
  produces = "application/json",
  consumes = "application/json",
@@ -105,9 +105,9 @@ ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete",required=tru
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
- @ApiResponse(code = 404, message = "Pet not found", response = Void.class),
- @ApiResponse(code = 405, message = "Validation exception", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Pet not found"),
+ @ApiResponse(code = 405, message = "Validation exception") })
  @RequestMapping(value = "/pet",
  produces = "application/json",
  consumes = "application/json",
@@ -122,7 +122,7 @@ ResponseEntity<Void> deletePet(@ApiParam(value = "Pet id to delete",required=tru
  })
  }, tags={ "pet", })
  @ApiResponses(value = { 
- @ApiResponse(code = 405, message = "Invalid input", response = Void.class) })
+ @ApiResponse(code = 405, message = "Invalid input") })
  @RequestMapping(value = "/pet/{petId}",
  produces = "application/json",
  consumes = "application/x-www-form-urlencoded",

diff --git a/samples/client/petstore/spring-stubs/src/main/java/io/swagger/api/StoreApi.java b/samples/client/petstore/spring-stubs/src/main/java/io/swagger/api/StoreApi.java
@@ -22,8 +22,8 @@ public interface 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", response = Void.class, tags={ "store", })
  @ApiResponses(value = { 
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Void.class),
- @ApiResponse(code = 404, message = "Order not found", response = Void.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Order not found") })
  @RequestMapping(value = "/store/order/{orderId}",
  produces = "application/json",
  consumes = "application/json",
@@ -35,7 +35,7 @@ public interface StoreApi {
  @Authorization(value = "api_key")
  }, tags={ "store", })
  @ApiResponses(value = { 
- @ApiResponse(code = 200, message = "successful operation", response = Integer.class) })
+ @ApiResponse(code = 200, message = "successful operation", response = Map.class) })
  @RequestMapping(value = "/store/inventory",
  produces = "application/json",
  consumes = "application/json",
@@ -46,8 +46,8 @@ public interface 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", response = Order.class, tags={ "store", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Order.class),
- @ApiResponse(code = 400, message = "Invalid ID supplied", response = Order.class),
- @ApiResponse(code = 404, message = "Order not found", response = Order.class) })
+ @ApiResponse(code = 400, message = "Invalid ID supplied"),
+ @ApiResponse(code = 404, message = "Order not found") })
  @RequestMapping(value = "/store/order/{orderId}",
  produces = "application/json",
  consumes = "application/json",
@@ -58,7 +58,7 @@ public interface StoreApi {
  @ApiOperation(value = "Place an order for a pet", notes = "", response = Order.class, tags={ "store", })
  @ApiResponses(value = { 
  @ApiResponse(code = 200, message = "successful operation", response = Order.class),
- @ApiResponse(code = 400, message = "Invalid Order", response = Order.class) })
+ @ApiResponse(code = 400, message = "Invalid Order") })
  @RequestMapping(value = "/store/order",
  produces = "application/json",
  consumes = "application/json",