优点:
- 大大减少前后端的沟通
- 方便查找和测试接口
- 提高团队的开发效率
- 方便新人了解项目
第一步,写依赖
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
第二步:swagger配置类
@Configuration //定义成配置类
@EnableSwagger2 //开启swagger
public class SwaggerConfig {
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2).pathMapping("/").
select().
apis(RequestHandlerSelectors.basePackage("com.liushao.shop")).
paths(PathSelectors.any()).build().
apiInfo(new ApiInfoBuilder().title("秒杀项目").description("好好听课!").
version("1.1").
contact(new Contact("liushao","http://www.bjliushao.com","beijignliuhao@163.com"))
.license("The Apache").licenseUrl("http://www.bjliushaoapache.cn").build());
}
}
第三步:加注解
@Api():用在请求的类上,表示对类的说明
//控制层上写这个
@Api(tags = "控制器类")
//实体类上写这个
@ApiModel("图书类")
//方法上写这个
@ApiOperation("方法名描述")
访问网址
http://localhost:9000/swagger-ui.html
9000是自己的端口号
localhost是自己的地址