springboot dubbo resteasy 简易集成swagger

最新推荐文章于 2022-05-23 17:45:22 发布

原创

最新推荐文章于 2022-05-23 17:45:22 发布 · 1.3k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #resteasy #springboot

本文介绍了如何在SpringBoot、Dubbo和Resteasy集成环境中使用Swagger进行API文档的生成。通过配置bean创建OpenApiContext，并编写服务返回Swagger JSON内容，实现了几乎零代码集成。虽然SpringBoot的嵌入式Servlet不支持SPI添加servlet，但通过返回JSON内容，可以在Swagger UI中查看API文档。

之前在springmvc中集成swagger，轻松加愉快，整套springfox进来，ui加api都有了。

现在的新项目，采用了springboot + dubbo + resteasy直出restful api的方式，轻便确实轻便，但是不如springmvc的资料多。不过，也让我在使用中，增加了更多的机会去了解底层。

翻了下swagger的文档，他是已经支持了resteasy了。于是拿来了他的demo看看，确实很方便，直接就能出api。几乎是0代码集成。他是使用servlet方式集成进去的。但是我的springboot，不支持在嵌入式servlet下用spi增加servlet。

所以我最后选用了直接添加service的方式。

首先增加一个config bean，创建一个openapicontext。后续可以用这个来得到swagger内容

@Configuration
public class SwaggerConfig {

    @Bean
    public OpenApiContext openApiContext(){
        Set<Class<?>> resources = new LinkedHashSet();

        // 仅抓取有tag注解的路径
        Set beanList = SpringContextUtils.getClassSetOfAnnotation(Tag.class);
        resources.addAll(beanList);

        OpenApiContext openApiContext = null;
        if (!resources.isEmpty()) {
            // init context
            try {
                SwaggerConfiguration oasConfig = new SwaggerConfiguration()

最低0.47元/天解锁文章