swagger3自定义接口访问地址、增加接口前缀、pathMapping

swagger3接口文档  发布到服务器上时会出现的问题

众所周知 swagger很方便 我们在接口上加个注解就能自动更新文档ui界面,这样就会出现一个问题,如果我把项目发到服务器上,正好我的服务器配置了用名称分流量的路由。这个时候我swagger默认的接口地址,就会少一层。

例如我公司服务器  ip:port/project1是第一个项目;相同的ip:port/porject2是第二个项目。

而整个路径中的project1和project2是在路由上体现的。我项目中是不会写servlet.context-path的。

就是说 我在本地访问swagger ui的地址是 localhost:8080/swagger-ui/index.html

而我在服务器上访问相同项目的swagger ui 时  地址变成了 ip:port/project/swagger-ui/index.html

这个时候不管是在本地还是服务器上  swagger-ui界面里点execute的时候调用的接口地址分别是localhost:8080/apiName 和 ip:port/apiName

而服务器上正确的接口地址应该是ip:port/project/apiName

答案很简单但是我在网上搜了好久都没有搜到。可能是太简单了所有人都觉得 这个东西是默认 知道的吧。

就是在配置docket的时候 加一行 .pathMapping("/接口前缀")

加上这个东西之后swagger-ui的地址是不会变得  只是改变了swagger页面内的接口地址

 这里是pathmapping方法的源码

 pathmapping可以用参数传  把参数写在yml里

因为这样配置后  服务器上的接口地址是正确的  但是本地的接口地址就会多一层  或者发到其他服务器的时候  地址是不对的 所以这个地方要写成动态的

  • 4
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Swagger3中,可以通过自定义注解来进一步定制和扩展API文档的展示和功能。自定义注解允许开发者添加额外的信息,以便更好地描述和解释API接口。以下是Swagger3中常用的自定义注解: 1. @Api:用于描述整个Controller或接口的基本信息,包括接口的名称、描述等。 2. @ApiOperation:用于描述具体的API接口,包括接口的名称、描述、请求方法等。 3. @ApiParam:用于描述接口的参数,包括参数名称、描述、是否必须等信息。 4. @ApiModel:用于描述实体类或DTO的基本信息,包括类的名称、描述等。 5. @ApiModelProperty:用于描述实体类或DTO的属性,包括属性的名称、描述、示例值等。 通过使用这些自定义注解,开发者可以清晰地定义和展示API接口的各种信息,方便其他开发人员理解和使用接口。同时,Swagger3还提供了丰富的UI界面,可以直观地展示接口的参数和返回结果,并提供接口测试的功能,类似于Postman工具。这样开发人员可以方便地测试和调试接口,提高开发效率。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [Springboot整合Swagger3全注解配置(springdoc-openapi-ui)](https://blog.csdn.net/weixin_44768189/article/details/115055784)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [Swagger2注解的介绍](https://blog.csdn.net/weixin_33883178/article/details/92424879)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值