Springboot配置Open API

一、添加pom依赖

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

添加完成后，启动应用程序，即可访问默认路径/v3/api-docs 查看文档，如下所示：

http://localhost:8080/v3/api-docs/

可在配置文件application.properties设置自定义路径：

springdoc.api-docs.path=/api-docs

 自定义访问路径变为：

http://localhost:8080/api-docs/

 访问yaml格式的路径为：

http://localhost:8080/api-docs.yaml

访问swagger-ui页面：

http://localhost:8080/swagger-ui.html

二、注解

从swagger2到open api，注解发生了变化，对应关系如下：

swagger2	open api
@ApiParam	@Parameter
@ApiOperation(value="foo", notes="bar")	@Operation(summary = "foo", description = "bar")
@Api	@Tag
@ApiImplicitParams	@Parameters
@ApiImplicitParam	@Parameter
@ApiIgnore	@Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiModel	@Schema
@ApiModelProperty	@Schema
@ApiModelProperty(hidden = true)	@Schema(accessMode = READ_ONLY)
@ApiResponse(code = 404, message = "foo")	@ApiResponse(responseCode = "404", description = "foo")

三、官方文档地址

https://springdoc.org/