什么是Springfox
Automated JSON API documentation for API's built with Spring
官網(wǎng)地址：springfox.io
什么是Springdoc
springdoc-openapi java library helps to automate the generation of API documentation using spring boot projects.
官網(wǎng)地址：https://springdoc.org/v2/
注意：使用的是V2版本，這個(gè)版本支持springboot3.0
為什么改用springdoc
之前springboot3.0之前我用的都是Springfox來集成Swagger管理我們的API接口文檔，這也就是Springfox和Springdoc最主要的功能。因?yàn)镾pringfox已經(jīng)停止更新有段時(shí)間了，升級(jí)Springboot3.0以后會(huì)有更多問題暴露出來。Spring官網(wǎng)推薦了Springdoc，應(yīng)該不會(huì)短時(shí)間停更，所以改用Springdoc
具體實(shí)現(xiàn)
Springdoc使用也很簡單，基本上也是開箱即用，不需要任何的配置，直接就可以使用。
首先添加依賴：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.0.2</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
<version>2.0.2</version>
</dependency>兩個(gè)依賴添加上，我們就可以直接使用Swagger3的注解了
@Tag(name = "用戶管理")
@RestController
public class UserController {
private final Logger logger = LoggerFactory.getLogger(UserController.class);
@Operation(summary = "列表")
@PostMapping("list")
public ResultJson list() {
...
return ResultJson.success();
}
@Operation(summary ="新增")
@PostMapping("add")
public ResultJson add(AdminRole AdminRole) {
...
return ResultJson.success();
}
@Operation(summary ="修改")
@PostMapping("update")
public ResultJson update(AdminRole AdminRole) {
...
return ResultJson.success();
}
@Operation(summary ="刪除")
@PostMapping("delete")
public ResultJson delete(Integer id) {
...
return ResultJson.success();
}
}從Springfox遷移過來的，需要修改注解：
@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")文章來源：http://www.zghlxwxcb.cn/news/detail-406932.html
目前只用到了這些，這樣啟動(dòng)項(xiàng)目就可以看到熟悉的界面了，后面用到什么再補(bǔ)充。地址：http://ip:port/context-path/swagger-ui.html文章來源地址http://www.zghlxwxcb.cn/news/detail-406932.html
到了這里，關(guān)于Springboot3.0整合swagger，廢棄Springfox改用Springdoc的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
