Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
Swagger 让部署管理和使用功能强大的API从未如此简单。
1.引入Swagger2和swagger ui （在父工程中添加依赖）`
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>`
2.编写配置类
package com.swaggeri.test.ctrl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration //声明这是一个配置类
@ComponentScan(basePackages = {"com.swaggeri.test.ctrl"})//指定需要生成API文档的类所在的包路径
@EnableSwagger2 //swagger2启动注解
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("标题")
.description("描述")
.contact(new Contact("zy", null, null))
.version("版本")
.build();
}
}
| @Configuration | 声明这是一个配置类 |
|---|---|
| @ComponentScan(basePackages = {""}) | 指定需要生成API文档的类所在的包路径 |
| @EnableSwagger2 | swagger2启动注解 |
将项目启动发布到tomcat上，就能访问swaggerAPI了
访问的URL也是个固定的格式http://localhost:8080/swagger-ui.html
3.配置api生成
这里只会显示@ComponentScan(basePackages = {“com.swaggeri.test.ctrl”})，这个路径下的类生成的API
测试案例中只写了一个SwaggerCtrl 所以这里只显示，SwaggerCtrl 及里面的方法
package com.swaggeri.test.ctrl;
import com.alibaba.fastjson.JSONObject;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
@Api(value = "SwaggerCtrl", description = "Swagger")
@RequestMapping("/say")
@RestController
public class SwaggerCtrl {
@ApiOperation(value = "Swagger2入门")
@RequestMapping(value = "/helloSwagger2", method = RequestMethod.POST)
public JSONObject helloSwagger2(HttpServletRequest request,
@RequestBody JSONObject obj) {
JSONObject jsonObject = new JSONObject();
jsonObject.put("hello", "Swagger2!");
return jsonObject;
}
}
@Api(tags="")
用在请求的类上，表示对类的说明
- tags"说明该类的作用，可以在UI界面上看到的注解"
@ApiOperation(value="")
用在请求的方法上，说明方法的用途、作用
- value=“说明方法的用途、作用”
@ApiImplicitParams
用在请求的方法上，表示一组参数说明
@ApiImplicitParam
@ApiImplicitParam:指定一个请求参数的各个方面
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
header –> 请求头的获取：@RequestHeader
query –> 请求参数的获取：@RequestParam
path（用于restful接口）–> 请求路径变量的获取：@PathVariable
body（不常用）
form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值
@ApiResponses
用在请求的方法上，表示一组响应
@ApiResponse
用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel
主要有两种用途：
用于响应类上，表示一个返回响应数据的信息
入参实体：使用@RequestBody这样的场景， 请求参数无法使用@ApiImplicitParam注解进行描述的时候
@ApiModelProperty
用在属性上，描述响应类的属性