swagger的使用

swagger的使用

Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。Swagger UI – 将 OpenAPI 规范呈现为交互式 API 文档。swagger2于17年停止维护，现在最新的版本为 Swagger3（Open Api3）

knife4j(swagger的本地增强解决方案)

首先需要引入依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.0.0</version>
</dependency>

然后使用注解

@ApiModel 用对象来接收参数

@ApiModelProperty 用对象接收参数时，描述对象的一个字段

@Api 修饰整个类，描述类的作用

@ApiOperation 描述类的一个方法

@ApiimplicitParam 描述参数

@Apigonre 忽略该Api

@ApiError 描述错误返回的信息

该Api

@ApiError 描述错误返回的信息