我正在Sprinngboot应用程序中使用swagger 2(2.9.2)。
Dependency:
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
代码:
package com.khan.vaquar.swagger;
import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.google.common.base.Predicate;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
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 SwaggerConfig {
@Bean
public Docket postsApi() {
return new Docket(DocumentationType.SWAGGER_2).groupName("vaquar khan public-api").apiInfo(apiInfo()).select().apis( RequestHandlerSelectors.basePackage( "com.khan.vaquar" ) )
.paths(paths()).build();
}
private Predicate<String> paths() {
return or(regex("/.*"), regex("/.*"));
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("vaquar khan public-api")
.description("vaquar khan public-api app API reference for developers")
.termsOfServiceUrl("XXX-YYY-ZZZ.com").contact("[email protected]")
.license("vaquar khan License").licenseUrl("[email protected]").version("1.0").build();
}
}
我有近70种不同的微服务,很多是内部的,只有10种微服务是外部的。
现在使用@ApiIgnore在swagger文档内部隐藏微服务,我们忽略了swagger中的60个,只显示了10个外部api。
问题:
现在我要求外部用户只能在swagger文档中看到10个微服务,而内部微服务swagger(70)应该对开发人员和内部用户可见。
我们可以在应用程序属性@ApiIgnore中为生产商品定义任何方式并仅显示10个,而在开发配置属性中将隐藏@ApiIgnore
@Profile("dev")
@Controller
@RequestMapping("/internal/...")
@Api(value = "/internal/...", description = "Internal stuff")
public class OneOfTheInternalControllers { ... }
现在用配置文件标记所有内部控制器/端点。最后,如果您在生产模式下运行应用程序,则无需执行任何操作。@Profile("dev")
API将被隐藏。但是,如果您在本地或测试环境中运行应用程序,请传递以下JVM参数: