swagger基本使用

swagger用于在开发过程中，对后台功能进行测试。

maven依赖

<!--swagger-->

<dependency>

  <groupId>io.springfox</groupId>

  <artifactId>springfox-swagger2</artifactId>

  <scope>provided </scope>

</dependency>

<dependency>

  <groupId>io.springfox</groupId>

  <artifactId>springfox-swagger-ui</artifactId>

  <scope>provided </scope>

</dependency>

swagger配置类

import io.swagger.models.Contact;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Config {
	
	@Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }
	
	private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .build();
    }
}

启动微服务后，页面访问http://localhost:8001/swagger-ui.html，ip地址和端口号改成自己的。