17.swagger2

如何使用？

1. pom

   <!--swagger-->
   <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
   </dependency>
   <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
   </dependency>

2. config配置上配置Bean，

3. 配置类注解@EnableSwagger2

4. controller可添加注释类注解

   @Api：修饰整个类，描述Controller的作用
   @ApiOperation：描述一个类的一个方法，或者说一个接口
   @ApiParam：单个参数描述
   @ApiModel：用对象来接收参数
   @ApiModelProperty：用对象接收参数时，描述对象的一个字段
   @ApiImplicitParam：一个请求参数
   @ApiImplicitParams：多个请求参数

5. 倘若配置类是在其他模块。本模块一定扫描不到，所以要用注解修改一下扫描路径：

//@ComponentScan(basePackages = “com.heyu”) //这里感觉我不用加这个注解，因为这个模块我少加了一个包，没想到吧！！！哈哈

1. 浏览器访问路径：http://服务器ip:端口/swagger-ui.html

这里：http://localhost:8201//swagger-ui.html

疑问：

可以思考一下配置文件内容

package com.heyu.yygh.common.config;
import com.google.common.base.Predicates;
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.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;
/**
 * Swagger2配置信息
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }
    @Bean
    public Docket adminApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("heyu", "http://heyu.com", "2051349510@qq.com"))
                .build();
    }
    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("heyu", "http://heyu.com", "2051349510qq.com"))
                .build();
    }
}

两个bean组件，一个组件拦截一种请求，那也有注释！！！