SpringBoot3教程 - 18 SpringBoot集成Springdoc

当前主流的开发模式是前后端分离，这样前端在开发的时候想要知道后端接口的信息，就需要一个 API 文档，由于开发任务繁重，而且接口随时可能更新，如果手动来编写或更新 API 文档肯定累死人，所以有一个自动生成服务器接口文档的工具就很有必要了。

Swagger就是干这个的，不仅可以查看接口的信息，还可以在线测试接口。

但是使用 SpringBoot3，Swagger的支持有问题，所以我们可以使用 Spring 官方的推出的 springdoc-openapi。Springdoc 使用 OpenAPI 3.0 规范，这与 Swagger 使用的 OpenAPI 规范一致。实际上，Springdoc 生成的文档可以直接用于 Swagger UI 展示。

Springdoc官网：https://springdoc.org/

下面介绍一下如何在 SpringBoot项目中集成Springdoc。

18.1 创建SpringBoot项目

创建项目，不多说了。

18.2 添加依赖

在项目的 pom.xml 文件中添加如下依赖：

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

18.3 配置application.yml

在 application.yaml 中添加如下配置，生产环境不应该再暴漏 API 文档了，所以可以在 application-dev.yaml 文件中进行配置，在开发环境中使用就可以了。

内容未完......

查看完整内容 →