一、是什么?
这个解释简单点来讲就是说,swagger是一款可以根据resutful风格生成的生成的接口开发文档,
二、为什么要用?
1.不用再手写WiKi接口拼大量的参数,避免手写错误
2.后端只需要定义好接口,会自动生成文档,接口功能、参数一目了然
3.方法参数名修改、增加、减少参数都可以直接生效,不用手动维护
三、如何搭建
1.引入Swagger的依赖
一:引入Swagger依赖库
<!--引入swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
2.SpringBoot整合swagger
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket productApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //添加ApiOperiation注解的被扫描
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title(”swagger和springBoot整合“).description(”swagger的API文档")
.version("1.0").build();
}
}
3.参数说明
1.定义在类上:@Api
2.定义在方法上:@ApiOperation
3.定义在参数上:@ApiParam
4.后续说明
1.访问地址:本机地址:端口/swagger-ui.html