Swagger根据controller类中的注解生成接口文档,通过服务地址+swagger-ui.html访问并且可以在线调试接口。 以下是Swagger配置介绍:
1、先在pom.xml中添加Swagger依赖
<!-- Spring Boot 集成 swagger --> <dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> </dependency>
2、在项目配置文件application.yml或bootstrap.yml中配置Swagger扫描路径、title、description等信息
swagger: title: "xxx管理系统" description: "用户管理" base-package: com.product.manage enabled: true version: 1.0.0
3、启动类添加注解
@EnableSwagger2Doc
4、controller类通过@Api注解中的value、tags配置接口大类信息;通过@ApiOperation注解配置配置接口
@Api(value="用户管理部分", tags="用户管理部分") public class UserController{ @ApiOperation("用户信息查询接口") @PostMapping("/user/list") public Result<>...{} }
5、添加注解对模型类中的属性说明
@ApiModelProperty("用户ID")
本文作者:寒江孤影
本文链接:
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!