SpringDoc使用记录

# 为何使用SpringDoc

Swagger项目 (opens new window)已经很久没有跟新，在使用SpringBoot2.6之上的项目中使用时，启动报错 (opens new window)。而SpringDoc同样支持Swagger-UI,且与SpringBoot兼容性更好，所以选择使用SpringDoc。

# 快速开始

SpringDoc官方文档 (opens new window)有详尽的解释，这里只提供一些使用示例。

引入maven依赖

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-ui</artifactId>
      <version>1.7.0</version>
   </dependency>

1
2
3
4
5

配置文件中指定扫描包和路径匹配

springdoc.packagesToScan=package1, package2
springdoc.pathsToMatch=/v1, /api/balance/**

1
2

创建一个OpenAPI Bean

  @Bean
  public OpenAPI springShopOpenAPI() {
      return new OpenAPI()
              .info(new Info().title("SpringShop API")
              .description("Spring shop sample application")
              .version("v0.0.1")
              .license(new License().name("Apache 2.0").url("http://springdoc.org")))
              .externalDocs(new ExternalDocumentation()
              .description("SpringShop Wiki Documentation")
              .url("https://springshop.wiki.github.org/docs"));
  }

1
2
3
4
5
6
7
8
9
10
11
12

参考链接 (opens new window)

编辑

上次更新: 2023/07/27, 13:53:49