SpringBoot中配置Swagger，并自动生成接口文档

一、配置Swagger

1.1前言

我们配置swagger是基于spring boot3.X+Java17的。

根据官方文档：https://springdoc.org/

这说明在我们的开发环境下，不能用原本的swaggerV3，而是要用springdoc-openapi

1.2配置

首先生成一个spring boot项目（没有额外依赖）

生成方式可以参考SpringBoot+MySQL的简单运用(Hello World API)-CSDN博客

然后在IDEA中打开本项目。

打开pom.xl文件，添加依赖

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.5.0</version>
   </dependency>

二、编写业务程序

2.1 创建控制器类

在com.example.demo包下，创建名为HelloWorldController的Java类

代码如下

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class HelloWorldController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

完成之后，应如下图

2.2Maven构建

首先clean，然后package，如果不知道如何操作，可以参考下述文章通过Restful接口实现对数据库进行基本的读写操作_通过接口的方式读写数据库-CSDN博客

2.3查看页面

首先运行demoapplication程序。

然后访问页面：http://localhost:8080/swagger-ui.html

可以进一步测试，点击图中try it out

出现下述结果，成功返回了“Hello，World”