首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Swagger2 >文档化SpringBoot MvcEndpoint

Swagger2 >文档化SpringBoot MvcEndpoint
EN

Stack Overflow用户
提问于 2016-08-26 06:49:19
回答 1查看 1.7K关注 0票数 3

我目前正在我的SpringBoot项目上试用SpringBoot(它工作得很好),但是它只选择了我的@RestController类。

我在想:

  1. 它能用来捡起Spring-Actuator MvcEndpoint吗?
  2. Swagger2组件(如/swagger-ui.html/v2/api-docs)能否托管在)下而不是server.port下?

Application.java

代码语言:javascript
复制
@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 (也称自定义执行器端点)

代码语言:javascript
复制
@Component
public class AdminController implements MvcEndpoint { ... }

application.yml

代码语言:javascript
复制
server.port: 8080
management.address: 127.0.0.1
management.port: 8081

build.gradle

代码语言:javascript
复制
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
  • 梯度:3.0
EN

回答 1

Stack Overflow用户

发布于 2016-11-04 09:57:46

是的,它是eaiser定制它来选择“弹簧启动-启动-执行器”退出端点。

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

以下是配置类:

代码语言:javascript
复制
@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中获得API。

以下是github中的演示项目。

2)我真的不知道您对“地址:端口,而不是server.port”的确切含义,很明显,它是托管在"address:port“中的,就像"localhost:8080”一样,请提供更多的信息。

票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/39159998

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档