swagger管理api,一键导出

swagger是我们比较常用的api管理器,在对应的swagger页面可以让我们清晰地看到api情况,让我们可以自由自测,我们项目也都用了api,另外还增加了导出功能。

第一篇说到我们api对接用的是YApi,每当有新需求时,后台首先定义接口,然后维护到YApi上,方便前端对接。维护可以手动录入,也可以通过导出的方式导出为json格式文件,再在YApi上导入,这样是最快的。

为了达到这个目标,有以下几点:

1.项目启用Swagger

2.注册Api Docket

3.实体定义ApiModel,属性定义ApiModelProperty

4.接口定义好ApiOperation

导出使用,启动服务后,在地址栏输入http://IP:Port/swagger-export/对应的业务Controller的地址/*

比如 http://192.168.100.17/api/XX/XXX/*,就会导出这个Controller所有的Api

导出实现,思路大概是请求Swagger api地址,获取某服务的所有Api

再根据指定的Controller匹配出对应的api返回

根据实际情况处理,比如参数处理

 返回一个JSon Object,包括path,tags等信息,key值可以根据需求自定义。

思考和讨论:

这样导出Api好方便噢,可以借鉴。当然现在也有很多Api管理组件,可以根据情况使用,当我们有一颗探索求知的决心,加以实践和付出,以认真的态度对待,相信能够完成。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值