@ApiResponses

github 代码示例： https://github.com/CoderFreeMan/swagger-demo

在 Rest 接口上使用，用作返回值的描述

一个包装器，允许列出多个 ApiResponse，若果你需要描述单个 ApiResponse，你仍然必须使用此注解并将@ApiResponse 包装在一个数组中

属性名称	数据类型	默认值	说明
value	ApiResponse[]		ApiResponse 列表

@ApiResponse

在 Rest 接口或类上和 @ApiResponses 组合使用，组装返回参数说明

描述操作的可能响应，这可用于描述 Rest API 调用中可能的成功和错误 code 码。此注解可以在方法或类级别应用；仅当在方法级别或抛出时未定义相同代码的@ApiResponse注解时才会解析类级别注解异常，如果响应中使用了不同的响应类，则可以通过将响应类于响应码组合使用。注意swagger不允许单个响应代码的多个响应类型。此注解不直接使用，单独使用时swagger不会解析，应该和ApiResponses组合使用。

属性名称	数据类型	默认值	说明
code	int		响应的 HTTP状态码
message	String		伴随响应的人类可读的消息
response	Class<?>	Void.class	用于描述消息有效负载的可选响应类，对应于响应消息对象的 schema 字段
reference	String	“”	指定对响应类型的引用，指定的应用可以使本地引用，也可以是远程引用，将按原样使用，并将覆盖任何指定的response()类
responseHeaders	ResponseHeader[]	@ResponseHeader(name = “”, response = Void.class)	可能响应的 header 列表
responseContainer	String	“”	声明响应的容器，有效值为List,Set,Map，任何其他值都将被忽略

@ Api ：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解 " value="该参数没什么意义，在UI界面上也看到，所以不需要配置use case:@ Api (tags="APP用户注册Controller") @ Api Operation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备... 我在看公司之前的文档，发现了@schema 注解，不太了解，所以查询了一些资料，把我的见解记录下：开始的时候，没查到太多信息，后来查到了，原来就是用过的@ API model 注解，一个是 swagger 2常用的注解，一个是 swagger 3常用的注解。 swagger 可以生成比较友好的在线 API 说明文档。友好的 API 说明重要性不言而喻，因为所谓 API ，肯定就是被用来调用的，事关不同群体的工作，比如前端后端，本公司与第三方公司。以往，制订数据接口，要正正经经地写一份正式的文档，名曰集成规范。但现在有了 swagger 框架，就方便许多了，直接利用代码生成在线的接口说明文档。不过最近在应用过程中遇到了一点问题。 Springfox 3.0 uses v3 models by default, but source.get Response s() gives wro 一般controller上@ Api (value="标题",tags="标签一",description="描述")publicclassxxxxxxxxxxxController{@ Api 用在总的controller上方value即名称，也可以默认不写value，默认会给与value例如@ Api ("标题")tags即对 api 的分类，类似于接口的标签用于进一步分类description即对接口的描述一般接口上如下示例对当前具体接口的描述，...... @ Api Response s({ @ Api Response (code = 200,message = "OK", response = TrainUserTEntity.class), 第二步,实体类属性上面加上注解 @ Api ModelProperty(value = "姓名", required = true) @ Api Response s：用于表示一组响应 @ Api Response ：用在@ Api Response s中，一般用于表达一个错误的响应信息 code：数字，例如400 message：信息，例如”请求参数没填好” response ：抛出异常的类 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说， Swagger 可以通过使用注解来生成接口文档，使得后端开发人员不必接口文档和代码各维护一套，代码即接口文档，代码更新接口文档可以自动更新。本篇文章主要讲解Springboot集成 Swagger 的配置，以及 Swagger 常用注解。另外， Swagger 也提供了根据接口文档生成前后端代码的功能，在此不做介绍。开放 API 规范（OAS）是⼀种无需编写实际 API 代码就可以记录 API 的方法。这是⼀种开放源代码格式，可以用来描述 API 。基于Open API 规范（Open API Specification，OAS）构建的开源接口文档自动生成工具，可以让开发人员快速设计、构建、记录以及使用Rest API 。–描述这种⼀般用在post创建的时候，使用对象提交这样的场景。用于方法，字段：表示对model属性的说明或者数据操作更改。用于类表示对类进行说明，用于参数用实体类接收，⽤在方法上，描述接口方法。用在入参上面，描述参数。 - MERRY CHRISTMAS -圣诞快乐Springboot 集成 Swagger 2(springfox)1、集成导入依赖：Springfox Swagger 2:<dependency> <groupId>io.springfoxgroupId> <artifactId>springfox- swagger 2artifactId&... 文章目录1. 背景介绍2. Swagger 2 注解说明2.1 @ Api ：用在请求的类上，说明该类的作用2.2 @ Api Operation：用在请求的方法上，说明方法的作用2.3 @ Api ImplicitParams：用在请求的方法上，包含一组参数说明2.4 @ Api Response s：用在请求的方法上，表示一组响应2.5 @ Api Model：用于响应类上，表示一个返回响应数据的信息3. Spring Boot中使用 swagger 3.1 添加 swagger 依赖3.2 swagger 配置文件4. referen