@ApiOperation vs Swagger中的@ApiResponse

时间:2017-04-11 13:51:09

标签: spring-boot swagger swagger-2.0

@ApiOperation有一个属性response,我们可以将响应类型传递给它。在@ApiResponse中,我们还有一个属性response,我们可以将响应类型传递给它。那么它们之间的确切区别是什么?

2 个答案:

答案 0 :(得分:2)

您必须在<insert id='insertPKs'> INSERT INTO requiredTable <include refid="Common.includeInsertPkSelect"> <property name="id" value="entityId"/> <property name="entityTable" value="entityTable"/> </include> <include refid="Common.includeInsertPkWhere"> <property name="id" value="entityId"/> <property name="entityTable" value="entityTable"/> </include> </insert> 中指定成功响应,同时可以在@ApiOperation中指定所有可能的响应对象。

@ApiResponse包含在@ApiResponse内,通常用于指定错误代码和@ApiResponsesResource Not Found等特殊情况。您还可以指定Bad Request回复,但并非强制要求,因为success中无论如何都会提到成功回应。

答案 1 :(得分:0)

@ApiOperation@ApiResponse的使用略有不同。使用@ApiOperation,您可以使用response指定REST方法的返回类型。使用@ApiResponse,您可以发回其他信息,如HTTP代码,用户定义的消息和其他标题,如果您想要返回