跳到主要内容

Spring Boot 3.x- RESTful API集成SpringDoc&Swagger-UI

系列文章目录​

系列文章:Spring Boot 3.x 系列教程

文章目录​

  • 系列文章目录
  • 前言
  • 一、快速开始
  • 二、Springdoc-openapi模块
    • Spring WebMvc支持
  • Spring WebFlux 支持
  • 三、Restful Api服务集成
    • 基础配置
  • 总结

前言​

springdoc-openapi 帮助使用Spring Boot项目自动化API文档的生成。springdoc-openapi的工作原理是在运行时检查应用程序，根据Spring配置、类结构和各种注释推断API语义。

自动生成JSON/YAML和HTML格式的API文档。这个文档可以通过使用swagger-api注解来完成。

官方网站：springdoc.org

由于Spring Boot 3使用的是Jakarta EE 9，对应的springdoc版本需要升级到v2,目前里程碑M2版本。支持以下内容：

  • OpenAPI 3
  • Spring-boot v3 (Java 17 & Jakarta EE 9)
  • JSR-303 特别注解 @NotNull, @Min, @Max, 和 @Size.
  • Swagger-ui
  • OAuth 2
  • GraalVM native images

> Swagger2已经在17年停止维护了，取而代之的是 Swagger3（基于OpenAPI 3),OpenApi是业界真正的 api 文档标准，其是由 Swagger 来维护。

这是一个基于社区的项目，不是由Spring Framework贡献者(Pivotal)维护的。

一、快速开始​

为了集成spring-boot和swagger-ui，将下列依赖添加到你项目即可(不需要额外的配置)。

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