SpringDoc最新版极速入门

1.缘起

由于使用了高版本的SpringBoot（>=3.0），年久失修的Springfox已经无法正常配置与兼容新版本的SpringBoot，因此换用了新的Swagger。

2.安装与配置依赖

在pom.xml的<dependency></dependency>之间添加如下代码

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

然后通过Maven获取依赖即可。

3.静态页面的配置

之前的网络文献到这一步后就直接启动了，但是在测试中我访问swagger-ui页面遇到了404问题。参考得知静态页面在新版本应该额外配置路径。

在application.properties中添加如下配置

springdoc.swagger-ui.path=/swagger-ui.html

4.访问swagger页面

通过以下链接访问html格式：

http://服务器名称或IP地址:端口/程序上下路径/swagger-ui.html

举例：http://localhost:8080/swagger-ui.html

json格式的OpenAPI表述通过以下链接访问：

http://服务器名称或IP地址:端口/程序上下路径/v3/api-docs

通过以下路径访问yaml格式：

/v3/api-docs.yaml

参考文献

springdoc-openapi官方资料库：OpenAPI 3 Library for spring-boot