@ApiResponse & swagger 注解

收心
发布
于
2022-03-30 15:01:31
发布
于
2022-03-30 15:01:31
一些公司没有专业的开发文档,后台提供的Knife4j接口没有直接的展示结果,特此追加新的内动
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
描述操作的可能响应。
这可用于描述 REST API 调用中可能的成功和错误代码。您可能会或可能不会使用它来描述操作的返回类型(通常是成功的代码),但也应该使用ApiOperation来描述成功的响应。
这个注解可以应用在方法或类级别;只有在方法级别或抛出的异常中未定义具有相同代码的 @ApiResponse 注释时,才会解析类级别注释
如果您的 API 对这些响应使用不同的响应类,您可以在此处通过将响应类与响应代码相关联来描述它们。请注意,Swagger 不允许单个响应代码有多种响应类型。
这个注解不直接使用,不会被 Swagger 解析。它应该在ApiResponses中使用。
ApiOperation , ApiResponses
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiResponse {
* 响应的 HTTP 状态代码。
* 该值应该是正式的HTTP 状态代码定义之一。
int code();
* 伴随响应的人类可读消息。
String message();
* 描述消息有效负载的可选响应类。
* 对应于响应消息对象的 `schema` 字段。
Class<?> response() default Void.class;
* 指定对响应类型的引用。指定的引用可以是本地的或远程的,将按原样使用,并将覆盖任何指定的 response() 类
String reference() default "";
* 与响应一起提供的可能标头列表。
* 返回值:
* 响应标头列表。
ResponseHeader[] responseHeaders() default @ResponseHeader(name = "", response = Void.class);
* 声明一个包装响应的容器。
* 有效值为“List”、“Set”或“Map”。任何其他值都将被忽略。
String responseContainer() default "";
* Examples for the response.
* @since 1.5.20
* @return