Swagger 常用注解 - 知乎 (zhihu.com)

@Api()

用于类,表示标识这个类是swagger的资源。

@Operation

@ApiOperation

用于方法,表示一个http请求的操作


value:对该操作进行简单的描述,尽量控制在120字符以内。

notes:对操作的详细描述。

httpMethod:指定操作使用的HTTP方法类型,可选值: “GET”、“HEAD”、“POST”、“PUT”、“DELETE”、“OPTIONS”和“PATCH”。

tags:用来给操作打标签,Swagger UI 将在操作列表下面展示 tag 列表,每个 tag 下面展示拥有该 tag 的操作列表。(就是分组)

response:指定操作的响应的类型,手动设置此属性将覆盖任何自动生成的数据类型。

hidden:从操作列表中隐藏操作。


@ApiIgnore

忽略该API


@OpenAPIRequestHeaders

自定义接口