Swagger基本使用

Swagger

1. 引入依赖

   <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>
   

2. 在wanxinp2p_consumer工程的application.propertis中配置swagger的启动开关

   # 应用程序名称 spring.application.name=consumer-service
    # 微服务访问路径 server.servlet.context-path=/consumer 
    # 开启swagger swagger.enable=true
   

3. 在wanxinp2p_consumer工程的config包中添加一个配置类

   @Configuration
   @ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
   @EnableSwagger2
   public class SwaggerConfiguration {
   
   @Bean
   public Docket buildDocket() {
   	return new Docket(DocumentationType.SWAGGER_2)
   			.apiInfo(buildApiInfo())
   			.select()
   			// 要扫描的API(Controller)基础包
   			.apis(RequestHandlerSelectors.basePackage("cn.itcast.wanxinp2p"))
   			.paths(PathSelectors.any())
   			.build();
   }
   
   private ApiInfo buildApiInfo() {
   	Contact contact = new Contact("努力的程序员","","");
   	return new ApiInfoBuilder()
   			.title("努力的程序员-用户服务API文档")
   			.description("包含用户服务api")
   			.contact(contact)
   			.version("1.0.0").build();
   }
   

}

Swagger常用注解

在Java类中添加Swagger的注解即可生成Swagger接口文档，常用Swagger注解如下：
@Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接
口 @ApiParam：单个参数的描述信息
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数的描述信息
@ApiImplicitParam属性