springdoc-openapi

springdoc-openapi

简介

springdoc-openapi 是一款类似于 springfox 的社区项目，可以通过注解生成文档，并且提供了 swagger-ui 方便调试。

使用方式

引入项目依赖：

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

注: Spring Boot 3.0 修改了引入包。

配置 swagger 地址：

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

然后在程序代码中加入如下注解及其参数即可：

• controller
  • @Tag
  • @Parameter
  • @Operation
  • @ApiResponse
• module
  • @Schema

注：相关注解的详细说明参见 swagger 文档。

参考资料

官方网站

官方例程

注解说明文档

swagger 官网