Swagger2使用

1.Swagger在单个服务中的使用

1.1依赖导入

	<!--引入swagger支持-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!--引入swagger ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

1.2在主配置类上导入swagger2配置@Import( Swagger2.class)

1.3swagger2配置类

@Configuration
@EnableSwagger2 //开启swagger2的支持
public class Swagger2 {
 
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //对外暴露服务的包,以controller的方式暴露,controller对应的包名.
                .apis(RequestHandlerSelectors.basePackage("com.wal.hrm.web.controller"))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXXapi")
                .description("XXXX服务接口文档说明")
                .contact(new Contact("wal", "", "wal@wal.com"))
                .version("1.0")
                .build();
    }
}

2.Swagger2结合zuul网关

通过网关访问各个服务的接口文档

2.1在网关服务中导入依赖

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

2.2 网关主配置类

@Import(SwaggerConfig.class)//导入swagger2配置

2.3Swagger2配置类

DocumentationConfig 该配置类为SwaggerConfig的子配置类

//swagger配置zuul端
@Component
@Primary
public class DocumentationConfig implements SwaggerResourcesProvider {
    @Override
    public List<SwaggerResource> get() {
        List resources = new ArrayList<>();
        //添加所有的微服务的文档资源
        /**
         * 参数:
         * name：自定义的服务的名字
         * location:指定是微服务的路径   /前缀/服务名/v2/api-docs
         */
        resources.add(swaggerResource("系统管理", "/hrm/system/v2/api-docs", "2.0"));

        return resources;
    }

    private SwaggerResource swaggerResource(String name, String location, String version) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setLocation(location);
        swaggerResource.setSwaggerVersion(version);
        return swaggerResource;
    }
}

SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXX平台")
                .description("XXX综合平台接口文档说明")
                .termsOfServiceUrl("http://localhost:1020") //网关的ip地址
                .contact(new Contact("wal", "", "wal@wal.com"))
                .version("1.0")
                .build();
    }
}