本文針對 SpringBoot 3.x 版本!!
SpringDoc v2 官方文檔:https://springdoc.org/v2/
首先
舊版本的 swagger 和 1.x 版本的SpringDoc 均不支持 SpringBoot 3,所以對于 SpringBoot3 如下的兩種 Swagger 或 SpringDoc 依賴均不可用,注意,是不可用
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>x.x.x</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>x.x.x</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>x.x.x</version>
</dependency>
正確的 SpringDoc 依賴
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.1.0</version>
</dependency>
其次(最坑人的地方)
無數(shù)的文章甚至官方文檔都表示,swagger-ui 界面的網(wǎng)址是 http://server:port/swagger-ui.html,訪問這個網(wǎng)址,一直是404,天王老子來了也是404,就算在 application.properties 中設(shè)置了如下內(nèi)容,也不管用:
springdoc.swagger-ui.path=/swagger-ui.html
但是打開 Demo Spring Boot 3 Web MVC with OpenAPI 3 這個官方提供的 Demo 后,顯示的網(wǎng)址是 http://server:port/swagger-ui/index.html, 把網(wǎng)址換成這個,瞬間打開!!
所以,正確的解決辦法就是,訪問 http://server:port/swagger-ui/index.html
Swagger (SpringFox) 遷移到 SpringDoc 后注解寫法補(bǔ)充
官方文檔中僅給出了如下說明:
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 改完就報(bào)錯啊,汗。正確的改法如下:文章來源:http://www.zghlxwxcb.cn/news/detail-602411.html
@Schema(name = "password", description = "密碼")
private String password;
其他待補(bǔ)充文章來源地址http://www.zghlxwxcb.cn/news/detail-602411.html
到了這里,關(guān)于【SpringDoc】SpringBoot 3 swagger-ui.html 報(bào)404 SpringDoc 官方文檔問題(可能)的文章就介紹完了。如果您還想了解更多內(nèi)容,請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!