springboot中集成Swagger
Swagger的使用
一.springboot中使用Swagger
1.去maven的官网上上找swagger的依赖
maven官网,搜索springfox,这是两个必须的Springfox Swagger2和Springfox UI的依赖添加到你的pom文件。
2.编写你的Swagger配置文件类
编写Swagger的配置类
注意点
1. 用@EnableSwagger2,开启swagger2
- 向容器中添加Docket,这是Swagger的docket实例
- 如果你想有几个接口组,多注入几个docket实例到spring容器
//作者信息
private static final Contact DEFAULT_CONTACT = new Contact("夏烨", "https://segmentfault.com/u/xiaye_5e702b22aea45", "1159395895@qq.com");
//配置swagger 的 docket实例
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//增加组名
.groupName("xiaye")
//链式的编程,下面是一组
.select()
//指定要扫描的包
.apis(RequestHandlerSelectors.basePackage("com.xy.hms.controller"))
.build();
}
private ApiInfo apiInfo(){
return new ApiInfo(
"night的swagger文档"
, "swagger学习测试"
, "1.0"
, "urn:tos"
, DEFAULT_CONTACT
, "Apache 2.0"
, "http://www.apache.org/licenses/LICENSE-2.0"
, new ArrayList());
}
3.启动项目,访问swagger-ui.html
4.实体类上的注释
@ApiModel(value="")
对实体类的注释@ApiModelProperty(value="")
对实体属性的注释
前提是你的controller返回了这个实体对象,那么在model中就可以找到对应的注释
5.contrller上的注释
1.@Api(tags = "用户登录控制类")
对controller的注释
2.@ApiOperation("登录控制")
这是对方法的注释