swagger2 model不显示 找不到model @ApiModel注解 不显示问题

Swagger与@RequestBody详解
最新推荐文章于 2025-09-06 07:49:45 发布
原创 最新推荐文章于 2025-09-06 07:49:45 发布 · 2.9w 阅读 · 12 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文深入探讨了在使用Swagger时，如何正确应用@ApiModel和@RequestBody注解，以确保API文档的准确性和前后端交互的流畅性。文章指出，若在Controller中未使用@RequestBody，即使已标注@ApiModel，Swagger也可能无法正确显示model信息，造成spring与swagger的耦合问题，且错误不易察觉。同时，详细解析了@RequestBody的功能，包括处理不同content-type的内容、将JSON字符串绑定到bean以及在springBoot中使用时的注意事项。

使用swagger的 @ApiModel注解的时候有个坑 就是必须在controller 使用 @RequestBody 注解 否则无法显示models

而且不报错，此时swagger就和 spring 耦合了，而且问题难以排查,

1、@requestBody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。

2、通过@requestBody可以将请求体中的JSON字符串绑定到相应的bean上，当然，也可以将其分别绑定到对应的字符串上。

3 springBoot 中 使用@requestBody注解的话， 前端传递参数时需要JSON格式的参数，而且Content-Type为：application/json;charset=UTF-8 格式

  @RequestBody的使用需要加载MappingJackson2HttpMessageConverter，但是SpringBoot的官方文档提到，这个是默认已经加载的了

内事不决问百度，百度百度白百度——Swagger 配置Model 但接口不显示描述信息的,响应参数名称不同
隔壁老瓦的专栏
06-22 1113
内事不决问百度，百度百度白百度 搜索大部分都是描述基本配置或者加@ReponseBody； 但是本身代码使用的 RestController注解 是个组合注解，排除原因； 还得从自身代码找原因： public class ApiResult<T> extends HashMap 查看结果集的类是继承HashMap的，有可能造成swagger没法解析； 于是，修改代码为 public class ApiResult<T> 重启服务 发现好了： 说说..
百度百度白百度 Swagger配置Model但接口不显示描述信息的，响应参数名称不同Java
TechRoar的博客
09-03 1056
通过正确配置Swagger的注解和附加的配置，我们可以确保生成的API文档中能够正确显示Model的描述信息和参数名称。在使用Swagger进行API文档生成时，有时候可能会遇到以下问题：配置了Swagger的Model，但是在生成的API文档中，接口没有显示描述信息，而且响应参数的名称与预期不符。然而，有时候即使正确配置了Model的注解，Swagger仍然无法正确显示描述信息和参数名称。这些配置可以帮助Swagger正确扫描到Model的注解，并将其显示在生成的API文档中。在上述配置中，我们添加了。
Swag模块解析：schema生成复杂数据结构的方法
gitblog_00746的博客
09-06 642
在Go语言开发RESTful API时，手动编写Swagger文档不仅效率低下，还容易出现接口定义与代码实现不一致的问题。Swag（swagger）模块作为自动化API文档生成工具，通过解析Go代码注释和结构体定义，能够自动生成符合OpenAPI规范的Schema文档。然而，面对嵌套结构体、泛型、枚举等复杂数据结构时，开发者常面临类型转换错误、字段缺失、注释丢失等问题。本文将系统剖析Swag模块中...
swagger的@ApiModel无效
weiambt的博客
08-08 2207
今天在写swagger的注释的时候，发现我写的实体类，有一些类，在swagger-ui.html中的Models里面。于是查阅资料才发现，如果在Controller中没有调用这个实体，即使是加上了@ApiModel注解，也无法在接口文档上看到。为了能够看到所有的实体，于是专门写了一个TestController用来调用这些实体，使得这些实体能够在接口文档中显示。...
SpringBoot集成Swagger-Bootstrap-UI
Java
01-12 3166
SpringBoot集成Swagger-Bootstrap-UI
解决Swagger 添加了@ApiModel注解 在文档中不显示对象问题
m0_55584658的博客
08-17 2536
解决Swagger 添加了@ApiModel注解在文档中不显示对象问题
swagger注解（@ApiModelProperty）实体类swagger-ui不显示问题
zhangwenchao0814的博客
05-13 7835
实体类首字母必须小写，否则swagger-ui界面显示对象的参数说明不显示、是否必输属性即使指定必输也是显示false；比如数据库中字段为B_WORKDAYFLAG，使用mybatis-plus代码生成器工具生成后是bWorkDayFlag，此时可以在mybatis-plus代码生成器中设置生成实体类时去掉字段前缀，如： strategy.setFieldPrefix("B_", "C_", "D_", "VC_"); //生成实体时去掉字段前缀 *** 代码*** public static void
Swagger2中 model不显示解决方案
weixin_46822367的博客
09-15 4099
方式一： 只要在接口中，返回值中存在实体类，就会被扫描到swagger中 @PostMapping("/account") public Account user(){ return new Account(); } 方式二： 在controller 使用 @RequestBody 注解 @ApiOperation(value = "添加用户", notes = "添加新用户") @PostMapping("/add") public
swagger @ApiModel 返回内容注释不显示问题
11-17
2. **Model注解使用不当**：确保你已经将`@ApiModel`注解添加到对应的Java类上，并且`description`属性包含了你想要展示的文本。同时，每个字段也需要使用`@ApiModelProperty`注解来添加描述。 3. **Swagger UI版本...
swagger2自定义注解 --为什么总有一个自定义model不能被识别!
sssdal19995的博客
05-31 2064
首先我们回顾一下 swagger2自定义注解 —你还在为每一个api创建一个ApiModel类而烦恼吗? 通过swagger的插件机制 我们可以对同一个类型在不同接口进行属性的显示和隐藏，但是当我们真正使用的时候，会发现一个奇怪的现象，总会有一个Model不能正常生成…如下图 是什么导致了这个现象 通过不断测试我们会发现 丢失的永远是最后一个被SwaggerModelReader 扫描到的model一切问题的根源在于下面这2行代码 springfox.documentation.spring.web.sc
Swagger2 常用注解使用及其说明
li-shaoyu的博客
08-11 524
目录 Swagger2 常用注解使用及其说明 1、 Api 2、ApiModel 3、ApiModelProperty 4、ApiParam 5、ApiOperation 6、ApiResponse 和 ApiResponses 7、ApiImplicitParam 和 ApiImplicitParams Swagger2 常用注解使用及其说明 1、 Api @Api 用在类上，说明该类的作用。可以标记一个 Controller 类作为 Swagger 文档资源。 ...
swagger2中@ApiModelProperty注释在测试网页不显示问题
weixin_45255645的博客
10-20 6074
swagger2在实体类中不能显示字段注释 // @NotBlank 用于String字段的校验 @ApiModelProperty(value = "项目名") @NotBlank(message = "项目名不为空") @Column(name = "project_name") private String ProjectName; @NotBlank(message = "项目时长不为空") @Column(name = "project_dur
swagger2界面看不到包含实体类的models的解决方法
weixin_38819361的博客
07-08 8348
随便在一个控制器里的一个方法里加个对象参数，给上注解@RequestBody ，重启springboot工程，刷新界面就行。
swagger无法显示@ApiModel问题
wsrzsfgst的博客
08-16 300
Swagger2的Model不显示返回的实体
lanlinlalala的博客
09-03 3649
原因：将实体类属性私有化了，同时并未给属性提供get，set方法，最后导致Model不显示请求返回的实体属性，解决方法：给私有的属性加上get、set方法即可，或者将属性public 最后： swagger依赖3.0版本的访问路径：http://localhost:8081/swagger-ui/index.html ...
Swagger Models实体类无法显示解决办法
在云端
12-12 8392
Swagger实体类无法显示解决办法？ 修改实体类！！
我的swagger上面怎么没有models_即使没有强大的NPU、GPU，AI门外汉也能开发AI应用-边缘AI推理框架Tengine
weixin_39737831的博客
11-19 567
本文转自 HackforFun 原标题：「在 RK3399 开发板上部署 Tengine AI 框架」TengineTengine 是 OPEN AI LAB 一款轻量级神经网络推理引擎，它针对 Arm 嵌入式平台进行了专门优化，对 Android、Linux 系统都提供了很好的支持。而且更加难能可贵的是 Tengine 并不依赖于专用 AI 芯片(即 Tengine 可以利用 GPU、NPU 这...
Swagger怎么没有你要的model？一个注解帮你解决
热门推荐
可乐的博客
05-05 1万+
需求描述 因为懒省事，不想写文档，前几日发现了Swagger这个好东西，文档轻轻松松自动生成，两个字，舒服！ 但是按照网上来的教程给自己的项目配了Swagger以后，嗯？ Models里面只有这个这，这让我亲爱的前端兄弟如何是好 如何解决model信息不足 找遍了材料，有各种方案，大致三种 我选择了最后才发现的，也是最舒服的第一种方案 第一种方案 Swagger的model里面之所以没有你需要的...
.net core中swagger设置参数（折叠、不显示models）
远近
08-23 6042
1、使用 NuGet 安装 Swashbuckle.AspNetCore 包 Install-Package Swashbuckle.AspNetCore 2、修改 Startup.cs 文件 // This method gets called by the runtime. Use this method to add services to the container. public vo...
除了使用 Swagger 注解，还有其他方式让 Model 在 Swagger 中显示吗？
最新发布
09-10
除了使用 Swagger 注解之外，还可以通过以下方式让 Model 在 Swagger 中显示： #### 利用 Spring 框架的特性 在 Spring Boot 项目里，只要 Model 类被 Spring 框架扫描到并且在接口方法中作为返回类型或者请求参数使用，Swagger 就能够识别并展示该 Model。例如，在控制器的接口方法中直接返回 Model 类的实例： ```java import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; class User { private Long id; private String name; public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } } @RestController public class UserController { @GetMapping("/user") public User getUser() { User user = new User(); user.setId(1L); user.setName("John"); return user; } } ``` 这里 `User` 类没有使用 Swagger 注解，但由于它在控制器方法中作为返回类型，Swagger 会自动识别并展示该 Model。 #### 手动配置 Swagger 可以在 Swagger 的配置类里手动添加 Model 信息。以 Springfox 为例，在 `Docket` 配置中使用 `additionalModels` 方法添加 Model 类： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.Collections; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build() .additionalModels(new ModelRef("User")); } } ``` 这样即使 `User` 类没有使用 Swagger 注解，也会在 Swagger 中显示。
评论 15
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值