一、Swagger2简介
1、Swagger2优点
整合到Spring Boot中,构建强大RESTful API文档。省去接口文档管理工作,修改代码,自动更新,Swagger2也提供了强大的页面测试功能来调试RESTful API。
2、Swagger2常用注解
Api:修饰整个类,描述Controller的作用ApiOperation:描述一个类的一个方法,或者说一个接口ApiParam:单个参数描述ApiModel:用对象来接收参数ApiProperty:用对象接收参数时,描述对象的一个字段ApiResponse:HTTP响应其中1个描述ApiResponses:HTTP响应整体描述ApiIgnore:使用该注解忽略这个APIApiError :发生错误返回的信息ApiImplicitParam:一个请求参数ApiImplicitParams:多个请求参数
二、与SpringBoot2.0 整合
1、核心依赖
spring-boot.version:2.1.3.RELEASEswagger.version:2.6.1
2、Swagger2 配置
import org.springframework.context.annotation.Bean;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.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;/** * Swagger 配置文件 */@Configurationpublic class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.swagger.two")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("SpringBoot利用Swagger构建API文档") .description("使用RestFul风格, 创建人:知了一笑") .termsOfServiceUrl("https://github.com/cicadasmile") .version("version 1.0") .build(); }}
3、启动类添加注解
@EnableSwagger2@SpringBootApplicationpublic class SwaggerApplication { public static void main(String[] args) { SpringApplication.run(SwaggerApplication.class,args) ; }}
4、启动效果图
三、增删改查案例
1、添加用户
(1)、代码块
@ApiOperation(value="添加用户