基于spring boot使用swagger2为Jersey构建api文档

最新推荐文章于 2024-08-17 12:33:42 发布

vXZH

最新推荐文章于 2024-08-17 12:33:42 发布

阅读量3.3k

点赞数 1

本文链接：https://blog.csdn.net/u013379553/article/details/86663550

版权

Jersey 框架是一个比较常用的开源的RESTful框架,。相比spring mvc来说，Jersey实现了JAX-RS 标准，并且在编写rest api时，代码看起来更加直观。当我们写好接口后，通常是自己写一份api文档，但这样做随着时间的推移以及业务复杂性的增加，文档会变得越来越难维护，工作量也越来越大。为了解决这些问题，swagger2出现了，它可以很轻松的集成到spring boot中去，并且可以和我们的jersey配合，自动构建出强大的restful api文档，减少我们编写文档时的工作量，同时它还带有api测试功能，在生成的api文档下的每个api都有一个测试入口，非常方便。接下来我们就来看看如何为Jersey构建api文档。

一、添加依赖

        <!-- springboot 集成 jersey 、swagger 实现 JAX-RS Restful 開始 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jersey</artifactId>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-jersey2-jaxrs</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <!-- swagger 静态资源 -->
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>swagger-ui</artifactId>
            <version>2.2.10</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.hk2</groupId>
            <artifactId>spring-bridge</artifactId>
            <version>2.5.0-b34</version>
        </dependency>
        <!-- springboot 集成 jersey 、swagger 实现 JAX-RS Restful 結束 -->

二、配置jersey

在yml项目配置文件里，添加如下配置，给jersey的api增加前缀/rest，否则使用spring mvc时的controller的url都映射到jersey去了

spring:
  jersey:
    application-path: rest

编写jersey配置类



import com.company.industrial_park.controller.AuthorizationRequestFilter;
import com.company.industrial_park.controller.admin;
import com.company.industrial_park.controller.bbs.activity;
import com.company.industrial_park.controller.bbs.community;
import com.company.industrial_park.controller.bbs.vote;
import com.company.industrial_park.controller.common;
import com.company.industrial_park.controller.wx.WxMaUserController;
import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.jaxrs.listing.AcceptHeaderApiListingResource;
import io.swagger.jaxrs.listing.ApiListingResource;
import io.swagger.jaxrs.listing.SwaggerSerializers;
import org.glassfish.jersey.media.multipart.MultiPartFeature;
import org.glassfish.jersey.server.ResourceConfig;
import org.springframework.stereotype.Component;
import org.springframework.beans.factory.annotation.Value;

import javax.annotation.PostConstruct;

@Component
public class JerseyCo