YApi、Swagger

目录

一、YApi

1.1 介绍

1.2 使用

二、Swagger

2.1 介绍

2.2 使用方式

2.3 常用注解

---

一、YApi

1.1 介绍

        YApi是高效、易用、功能强大的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护API，YApi还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

        YApi让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。

        源码地址：https://github.com/YMFE/yapi

        要使用YApi，需要进行自己部署

1.2 使用

二、Swagger

2.1 介绍

        使用Swagger，只需要按照他的规范去顶i接口及接口相关的信息，再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等

        官网：https://swagger.io/

        knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

        <dependency>
            <groupId>com.github.xiaoymingroupId>
            <artifactId>knife4j-spring-boot-starterartifactId>
            <version>3.0.2version>
        dependency>

2.2 使用方式

操作步骤：

1. 导入knife4j的maven坐标
2. 导入knife4j相关配置类
3. 设置静态资源，否则接口文档页面无法访问
4. 在Login Check Filter中设置不需要处理的请求路径

 

2.3 常用注解

注解	说明
@Api	用在请求的类上，例如Controller，表示对类的说明
@ApiModel	用在类上，通常是实体类，表示一个返回响应数据的信息
@ApiModelProperty	用在属性上，描述响应类的属性
@ApiOperation	用在请求的方法上，说明方法的用途、作用
@AplimplicitParams	用在请求的方法上，表示一组参数说明
@ApilmplicitParam	用在@AplimplicitParams注解中，指定一个请求参数的各个方面