基于Jersey ResourceConfig的Swagger自定义应用类配置问题

我太懂这种纠结了——当项目用ResourceConfig而非Application作为基类时，Swagger的配置总是容易踩坑，毕竟ResourceConfig自己重写了不少核心逻辑，和标准Application的玩法不一样。下面给你一套靠谱的解决方案：

最推荐的配置方式：用ResourceConfig原生API注册Swagger #

ResourceConfig本身提供了更简洁的组件注册方法，完全不需要重写getClasses()或者getSingletons()，直接在构造函数里搞定：

import io.swagger.jaxrs.listing.ApiListingResource;
import io.swagger.jaxrs.listing.SwaggerSerializers;
import org.glassfish.jersey.server.ResourceConfig;

public class YourAppConfig extends ResourceConfig {
    public YourAppConfig() {
        // 自动扫描并注册你的API所在包下的所有资源类
        packages("com.yourteam.yourproject.api");
        
        // 手动注册Swagger的核心组件
        register(ApiListingResource.class);
        register(SwaggerSerializers.class);
        
        // 配置Swagger的基础信息（按需调整）
        property("swagger.api.basepath", "/your-api-root");
        property("swagger.info.title", "你的API服务名称");
        property("swagger.info.version", "v1.0.0");
        property("swagger.info.description", "API功能描述");
    }
}

为什么不要重写getClasses()/getSingletons()？ #

ResourceConfig内部维护了自己的组件注册容器，如果你强行重写这两个方法，会覆盖掉它默认的注册逻辑——不仅Swagger组件可能加载失败，就连Jersey自身的一些核心功能都可能出问题。除非你完全清楚自己在做什么，否则别这么干。

如果你已经重写了这些方法（紧急修复方案） #

如果项目里已经重写了getClasses()或getSingletons()，那必须手动把Swagger的组件加进去：

@Override
public Set<Class<?>> getClasses() {
    Set<Class<?>> resourceClasses = new HashSet<>();
    // 添加你的业务API类
    resourceClasses.add(UserApi.class);
    resourceClasses.add(OrderApi.class);
    
    // 一定要加上Swagger的两个核心类
    resourceClasses.add(ApiListingResource.class);
    resourceClasses.add(SwaggerSerializers.class);
    
    return resourceClasses;
}

验证配置是否生效 #

启动项目后，直接访问http://your-server:port/your-api-root/swagger.json，如果能返回结构化的Swagger JSON文档，说明配置成功了。

内容的提问来源于stack exchange，提问作者Venkateswarlu Raju