java - Swagger2 > 记录一个 SpringBoot MvcEndpoint

Question

我目前正在我的 SpringBoot 项目上试用 Swagger2(效果很好)，但是，它只会选择我的 @RestController 类。

我在想:

1. 它可以用来拿起一个 Spring-Actuator MvcEndpoint 吗？
2. 能否将 Swagger2 组件(例如 /swagger-ui.html、/v2/api-docs)托管在 management port (e.g. http://${management.address}:${management.port}) 下，而不是 server.port?

应用程序.java

@EnableSwagger2
@SpringBootApplication
public class Application {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

AdminController.java(又名自定义执行器端点)

@Component
public class AdminController implements MvcEndpoint { ... }

application.yml

server.port: 8080
management.address: 127.0.0.1
management.port: 8081

build.gradle

compile("org.springframework.boot:spring-boot-starter-actuator")
compile "io.springfox:springfox-swagger2:2.5.0"
compile "io.springfox:springfox-swagger-ui:2.5.0"

版本:

• SpringBoot: 1.4.0.RELEASE
• Gradle :3.0

Answer 1

是的，自定义它以选择“spring-boot-starter-actuator”暴露的端点更容易。

关键点是添加 customerize RequestHandlerSelectors 谓词，com.example.Swagger2Config.RequestHandlerSelectors 是一个很好的入门示例。

配置类如下:

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket actuator() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("Spring Boot Actuator")
                .select()
                .apis(RequestHandlerSelectorsExt.withInterface())
                .paths(PathSelectors.any())
                .build();
    }

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("App")
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    static class RequestHandlerSelectorsExt {
        public static Predicate<RequestHandler> withInterface() {
            return new Predicate<RequestHandler>() {
                @Override
                public boolean apply(RequestHandler input) {
                    return declaringClass(input) == EndpointMvcAdapter.class;
                }
            };
        }

        private static Class<?> declaringClass(RequestHandler input) {
            return input.getHandlerMethod().getMethod().getDeclaringClass();
        }
    }
}

然后就可以在swagger ui中获取API了。

这是 demo github中的项目。

2) 我真的不知道“地址:端口，而不是 server.port”的确切含义，显然它像“本地主机:8080”一样托管在“地址:端口”中，请附加更多信息这。