1.添加maven依赖
<!--Swagger-UI API文档生产工具--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency>
2.添加swagger配置类
@Configuration
@EnableSwagger2
public class Swagger2 {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select() //这里是自己的controller层路径
.apis(RequestHandlerSelectors.basePackage("com.zsq.glory.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 创建该API的基本信息（这些基本信息会展现在文档页面中）
* 访问地址：http://项目实际地址/swagger-ui.html
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2")
.description("更多请关注http://www.hao123.com")
.termsOfServiceUrl("http://www.baidu.com")
.contact("zsq")
.version("1.0")
.build();
}
}
3.编写测试controller
@Api(tags = "V1-AdminController" ,description = "牛的不行")
@RestController
@RequestMapping("/admin")
public class AdminController {
@ApiOperation(value = "测试",notes = "返回测试信息")
@GetMapping("/select")
@ApiImplicitParam(paramType = "query" ,name = "name",value = "用户名")
public Object select(String name){
return name+"123";
}
}
4.访问swagger http://localhost:8090/swagger-ui.html#/ ip 端口号填自己的 ok
Swagger使用的注解及其说明：
@Api：用在类上，说明该类的作用。
@ApiOperation：注解来给API增加方法说明。
@ApiImplicitParams : 用在方法上包含一组参数说明。
@ApiImplicitParam：用来注解来给方法入参增加说明。
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
l code：数字，例如400
l message：信息，例如"请求参数没填好"
l response：抛出异常的类
@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
l @ApiModelProperty：描述一个model的属性
注意：@ApiImplicitParam的参数说明：
|
paramType：指定参数放在哪个地方 |
header：请求参数放置于Request Header，使用@RequestHeader获取 query：请求参数放置于请求地址，使用@RequestParam获取 path：（用于restful接口）-->请求参数的获取：@PathVariable body：（不常用） form（不常用） |
|
name：参数名 |
|
|
dataType：参数类型 |
|
|
required：参数是否必须传 |
true | false |
|
value：说明参数的意思 |
|
|
defaultValue：参数的默认值 |