SpringDoc和Swagger使用

最新推荐文章于 2025-09-11 13:29:26 发布

m0_74824091

最新推荐文章于 2025-09-11 13:29:26 发布

阅读量1.2k

点赞数 8

CC 4.0 BY-SA版权

分类专栏：面试学习路线阿里巴巴文章标签：命令模式

本文链接：https://blog.csdn.net/m0_74824091/article/details/145655115

（1）springdoc.api-docs.path

（2）springdoc.swagger-ui.path

（3）springdoc.swagger-ui.operationsSorter

（4）springdoc.swagger-ui.tagsSorter

Swagger和Springdoc是两个常用的工具，用于生成和维护API文档，特别是针对基于REST的Web服务。它们有效地提升了API的可读性和可维护性，帮助开发者、产品经理和其他利益相关者更好地理解和使用所提供的API。

注意：Swagger支持springboot2.0但不支持springboot3.0

一、SpringDoc

Springdoc是一个开源的库，旨在将Spring Boot项目的RESTful API与OpenAPI 3文档生成器集成。Springdoc与Spring Boot应用无缝集成，并支持包括Swagger UI在内的多种用户界面。

1.添加依赖

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

2.配置代码

添加一个配置类，并添加xml配置

配置解释

springdoc:
  api-docs:
    path: /v3/api-docs
  swagger-ui:
    path: /swagger-ui.html
    operationsSorter: method
    tagsSorter: alpha

`（1）springdoc.api-docs.path`

属性路径:springdoc.api-docs.path
作用: 定义 OpenAPI 文档的访问路径。
默认值:/v3/api-docs
示例:
```
springdoc:
  api-docs:
    path: /v3/api-docs
```
配置后，API 文档可以通过http://<ho