You need to enable JavaScript to run this app. Swagger不显示API Models且未忽略默认响应码问题咨询
优惠活动
大模型
产品
解决方案
定价
更多

Swagger不显示API Models且未忽略默认响应码问题咨询

Swagger 两个问题修复方案

问题1:SimpleRequest、SimpleResponse Model未在Swagger UI展示,无Models区块

  • 检查Model类配置:确认两个Model类已添加@ApiModel注解,类属性添加@ApiModelProperty注解;使用Lombok的话确保类上加了@Data/@Getter注解,存在公共无参构造方法。
  • 确认接口已引用Model:检查Controller层接口是否明确将SimpleRequest作为@RequestBody参数、SimpleResponse作为方法返回值,Swagger默认仅扫描被接口实际引用的模型类。
  • 手动注册Model到Docket:若上述配置都正常仍不显示,可在Docket配置中手动注册模型,需先注入TypeResolver,再在Docket构造中添加additionalModels配置,修改示例见下文完整配置。

问题2:useDefaultResponseMessages(false)配置不生效,默认响应码仍展示

该配置不生效通常是版本兼容或未覆盖全部请求方法导致,按以下步骤修复:

  • 配置全局空响应覆盖默认值:SpringFox 2.9+版本仅配置useDefaultResponseMessages(false)无法完全清除默认响应,需针对所有HTTP请求方法单独配置全局响应列表,若不需要任何默认响应可直接配置为空列表。
  • 排查注解冲突:检查Controller类/方法上是否添加了@ResponseStatus、@ApiResponse等注解,此类注解优先级高于全局配置,会额外返回响应码配置。
  • 排查依赖冲突:确认项目未同时引入SpringFox和SpringDoc OpenAPI两类Swagger依赖,依赖冲突会导致配置不生效。

修复后完整Docket配置示例

@Autowired
private TypeResolver typeResolver;

@Bean
public Docket swaggerApi()
{
    // 针对所有HTTP方法配置空的全局响应,完全清除默认响应码
    List<Response> emptyGlobalResponses = new ArrayList<>();
    return new Docket(DocumentationType.SWAGGER_2).protocols(Sets.newHashSet("http", "https"))
            .apiInfo(new ApiInfoBuilder().title("InactiveAccountsApplication Pricing").version("1")
                    .contact(new Contact("InactiveAccountsApplication Services", null, "abc-services@xyz.com"))
                    .description("InactiveAccountsApplication returns the inactive accounts list")
                    .build())
            .useDefaultResponseMessages(false)
            // 逐个配置所有HTTP方法的全局响应为空
            .globalResponses(HttpMethod.GET, emptyGlobalResponses)
            .globalResponses(HttpMethod.POST, emptyGlobalResponses)
            .globalResponses(HttpMethod.PUT, emptyGlobalResponses)
            .globalResponses(HttpMethod.DELETE, emptyGlobalResponses)
            .globalResponses(HttpMethod.PATCH, emptyGlobalResponses)
            // 手动注册未自动扫描的Model
            .additionalModels(typeResolver.resolve(SimpleRequest.class), typeResolver.resolve(SimpleResponse.class))
            .select()
            .apis(RequestHandlerSelectors.basePackage(InactiveAccountsApplication.class.getPackage().getName()))
            .paths(PathSelectors.any()).build();
}

内容的提问来源于stack exchange,提问作者joven

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.21 10:24:00