日记52
之前前后端对接时,接口文档都是手写,容易出现更新不及时的问题,今天用Swagger自动生成接口文档。
引入 springfox-boot-starter 依赖,创建Swagger配置类,用 @Configuration 和 @EnableOpenApi 注解开启配置,设置文档标题、描述、版本等信息,同时配置要扫描的Controller包路径。
在Controller类和方法上添加注解: @Api(tags = "用户管理接口") 描述类的作用, @ApiOperation("根据ID查询用户") 描述方法功能, @ApiParam("用户ID") 描述参数含义。
启动项目后访问 http://localhost:8080/swagger-ui/index.html ,就能看到完整的接口文档,还可以直接在页面上测试接口,前后端沟通效率直接拉满。小问题:Swagger默认会暴露所有接口,通过配置 @ApiIgnore 注解可以隐藏不需要对外展示的接口。
浙公网安备 33010602011771号