java中如何使用Swagger生成在线接口文档

java中如何使用Swagger工具生成在线接口文档

文章目录

前言

一、Swagger、Knife4j是什么？

二、java中如何使用Knife4j

1.在pom.xml文件中引入knife4j的maven坐标

2.配置类中加入knife4j的相关配置

3.设置静态资源映射

4.项目实战

总结

---

---

前言

  Swagger是由美国软件公司SmartBear Software开发的一种用于描述和定义RESTful API的工具。目前，Swagger已经成为了API开发和管理领域中最流行的工具之一，被广泛应用于各种软件开发项目中。

---

一、Swagger、Knife4j是什么？

· Swagger是一种用于描述和定义RESTful API的工具和规范。它可以让开发人员更加方便地描述API的请求和响应结构、参数、错误码等信息，同时也能够生成交互式的API文档和客户端代码。通过使用Swagger，开发人员可以更加规范和标准化地设计和管理API，从而提高API的可读性、可维护性和可测试性。
· Knife4j是为 java MVC 框架集成Swagger生成API文档的增强解决方案

二、java中如何使用Knife4j

1.在pom.xml文件中引入knife4j的maven坐标

代码如下：

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