使用Swagger2构建RESTful API文档遇到的坑

最新推荐文章于 2025-06-16 16:13:01 发布
原创 最新推荐文章于 2025-06-16 16:13:01 发布 · 5.2k 阅读 · 4 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #Swagger2 

@ApiImplicitParam(name = "id", value = "用户ID",required = true, dataType = "Long")
这个里面少了一个参数：paramType="path"，否则无法从路径中获得id值。
SpringBoot集成Swagger3构建Restful API 文档
yinyin_xiao的博客
08-19 189
SpringBoot整合Swagger3测试
如何集成swagger2构建Restful API
08-25
本文将详细介绍如何集成Swagger2来构建RESTful API，以帮助开发者提高工作效率并提供清晰的API文档。 首先，我们需要在项目的`pom.xml`文件中添加Swagger2的依赖。Swagger2的两个关键组件是`springfox-swagger2`和`...
Swagger快速上手教程以及一些运行报错解决
qq_51933234的博客
01-17 4901
这篇文章记录了Swagger的一些基本使用方法，以及博主在使用Swagger使遇到的一些问题，博主记录下来希望可以帮助到大家！
自定义注解屏蔽Swagger接口文档属性
Ming_360的博客
06-09 965
描述 通过自定的注解屏蔽Swagger网页中的文档字段。 自定义注解 自定义注解ApiIgp，用在需要屏蔽的字段上。 import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 屏蔽Swagger接口文档传输对象属性 * 示例：@A
Swagger的使用教程
最新发布
weixin_69889539的博客
06-16 1654
什么是Swagger？ 官网：https://swagger.io/ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。主要是生成规范的后端接口文档，并兼顾后端接口测试功能。为什么使用Swagger？ 起初，后端开发过程中，程序员需要创建一份API文档来记录所有的接口细节，供其他开发人员使用提供的接口服务，但会存在以下的问题：接口众多，并且细节复杂需要根据接口的变化，不断修改API文档，非常麻烦，费时费力Sw
Swagger2.0@ApiResponse的response参数无效
小林同学的博客
11-27 3613
Swagger2.0@ApiResponse的response参数无效，查询了相关资料，说是因为Springfox3.0默认用swagger v3来返回信息，但有个地方又出毛病了。produces 属性，用来指定当前接口能够响应的媒体类型，也可以理解为此接口可以处理的媒体类型。（之后还使用 @ApiOperation(）添加response的方法进行尝试也是无效）大概意思是说如果没有设置媒体类型的话，将会导致该接口去忽略响应参数。所以接下就很简单了。今天在给swagger添加响应参数的时候发现无效。
swagger2测试单个文件或者多文件上传（springboot）
小石头
12-17 5620
单个文件 @ApiOperation(value = "上传视频接口",notes = "上传视频接口") @ApiImplicitParams({ @ApiImplicitParam(name = "uId",value = "上传用户ID，",paramType = "query",required = true,dataType = "int") }) @PostMapping(value = "/video/uplode", headers = "content-type=m
swaggerUI页面没有显示api
expect521的博客
09-01 4万+
如图，没有api：原因：basePackage写错修改错误代码：再次运行成功
Spring Boot中使用Swagger2构建强大的RESTful API文档
01-04
为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又...
SpringBoot集成Swagger2构建RESTful API文档
Spring Boot和Swagger2是当前流行的技术栈...综上所述，Spring Boot结合Swagger2不仅简化了RESTful API的开发，还提高了API文档的质量和易用性。在微服务架构的持续演进中，这种集成模式已成为API开发的主流选择之一。
记录Swagger2不现实api的坑
风清云淡的博客
12-25 3835
 我是用的swagger2的版本 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8...
swagger2被拦截器拦截，无法显示接口文档
厚积薄发
12-10 1万+
今天在项目中使用了拦截器，发现swagger的接口文档无法打开了，因此我在拦截器里面将swagger的url加入不拦截的路径里面 registry.addInterceptor(new CommonInterceptor()).addPathPatterns("/**") .excludePathPatterns("/swagger-resources/**", "...
解决swagger提示Failed to load API definition Fetch errorundefined
阿甘兄
10-16 2万+
直接提上问题图片： 首先保证Swagger配置没有错，具体可以参考之前写的博客：《淘东电商项目（05） - Swagger及网关统一管理API》 如果还有问题，最大的可能是端口被禁止访问了，只要在Linux服务器设置开放端口即可（比如开放10086端口）： sudo ufw allow from 127.0.0.1 to any port 10086 proto tcp ...
Swagger 2——@ApiOperation注解、@ApiModel注解、@ApiImplicitParams注解、@ApiImplicitParam注解无效解决方案
无限迭代中......
04-13 4003
问题描述 Spring MVC REST API使用springfox-swagger2。swagger一切都可以正常工作，但是我的问题是我无法在我的swagger文档中添加其他信息。 @RestController @RequestMapping("/persons") public class PersonController { Logger LOGGER = LoggerF...
swagger2常用注解说明
热门推荐
兴国-为梦想而战
08-01 15万+
@Api()表示标识这个类是swagger的资源 @ApiOperation()表示一个http请求的操作 @ApiParam()表示对参数的添加元数据 @ApiModel()表示对类进行说明，用于参数用实体类接收 @ApiModelProperty()表示对model属性的说明或者数据操作更改 @ApiIgnore()表示这个方法或者类被忽略 @ApiImplicitParam()单独的请求参
swagger2 注解说明
陌上离歌
10-22 1811
@Api：用在请求的类上，表示对类的说明     tags="说明该类的作用，可以在UI界面上看到的注解"     value="该参数没什么意义，在UI界面上也看到，所以不需要配置" @ApiOperation：用在请求的方法上，说明方法的用途、作用     value="说明方法的用途、作用"     notes="方法的备注说明" @ApiImplicitParams：用在请求的方法上，...
Swagger2上传文件方法注解
h363659487的博客
11-08 2万+
  @ApiOperation(value = "合同文件上传", notes = "合同文件上传") @ApiImplicitParam(name = "assetId", value = "凭证ID", required = true, dataType = "String", paramType = "String") @RequestMapping(value = "
Swagger踩坑之@ApiModel注解
coolorcool的博客
11-01 2万+
@ApiModel内的注释 不要出现相同 否则会将相同的vo内的字段进行合并
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值