【SpringDoc】SpringBoot 3 swagger-ui.html 报404 SpringDoc 官方文档问题(可能)

本文针对 SpringBoot 3.x 版本!!

SpringDoc v2 官方文档:https://springdoc.org/v2/

首先

旧版本的 swagger 和 1.x 版本的SpringDoc 均不支持 SpringBoot 3,所以对于 SpringBoot3 如下的两种 Swagger 或 SpringDoc 依赖均不可用,注意,是不可用

<dependency>
    <groupId>org.springdocgroupId>
    <artifactId>springdoc-openapi-uiartifactId>
    <version>x.x.xversion>
dependency>
<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>x.x.xversion>
dependency>
<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>x.x.xversion>
dependency>

正确的 SpringDoc 依赖

<dependency>
    <groupId>org.springdocgroupId>
    <artifactId>springdoc-openapi-starter-webmvc-uiartifactId>
    <version>2.1.0version>
dependency>

其次(最坑人的地方)

无数的文章甚至官方文档都表示,swagger-ui 界面的网址是 http://server:port/swagger-ui.html,访问这个网址,一直是404,天王老子来了也是404,就算在 application.properties 中设置了如下内容,也不管用

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

但是打开 Demo Spring Boot 3 Web MVC with OpenAPI 3 这个官方提供的 Demo 后,显示的网址是 http://server:port/swagger-ui/index.html, 把网址换成这个,瞬间打开!!

所以,正确的解决办法就是,访问 http://server:port/swagger-ui/index.html

Swagger (SpringFox) 迁移到 SpringDoc 后注解写法补充

官方文档中仅给出了如下说明:

Replace swagger 2 annotations with swagger 3 annotations (it is already included with springdoc-openapi-starter-webmvc-ui dependency). Package for swagger 3 annotations is io.swagger.v3.oas.annotations.
@Api → @Tag
@ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters
@ApiModel → @Schema
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
@ApiModelProperty → @Schema
@ApiOperation(value = “foo”, notes = “bar”) → @Operation(summary = “foo”, description = “bar”)
@ApiParam → @Parameter
@ApiResponse(code = 404, message = “foo”) → @ApiResponse(responseCode = “404”, description = “foo”)

但是 MyBatis-Plus-Generator 生成的代码,在 entity 属性上的注解方法是

@ApiModelProperty("密码")
private String password;

文档只告诉我,要把 @ApiModelProperty 改成 @Schema 改完就报错啊,汗。正确的改法如下:

@Schema(name = "password", description = "密码")
private String password;

其他待补充

你可能感兴趣的:(一个bug改一天系列,spring,boot,SpringDoc)