app后端开发一:swagger-ui教程-构建api接口文档工具

本文介绍了如何使用Swagger-UI作为app后端开发的API接口文档工具,强调了良好文档对于提升开发效率的重要性。作者分享了从Word文档到自建接口管理系统的历程,最后推荐了一天内改造的Swagger-UI中文版,展示其在线测试和自动构建Model的功能,提高了团队协作效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

声明


之前写过关于app后端开发的一系列文章,那是我第一次做app后端开发,存在很多不足,本想好好修改一下,想想还是重新写吧,这样子也能让我博客文章看起来多一点嘛,万一以后找工作,别人一看我博客这么多内容,是不是很屌?
这次文章先从构建resetful风格的api文档工具开始。没有一个好的文档工具,在app前端人员开发过程中会导致开发效率极低,而且时不时的,他们就来找你跟他们断点一下。

我的文档经历

这里先不讨论我的数据传输是否合理,仅仅以这些数据作为一个演示。后面会有专门的章节进行app数据传输加密的讲解。


  1. 在我第一次开发app后端的时候,使用的word文档,就是我先将所有数据格式定义好,会返回什么样的数据写好。前端人员照这个来进行开发。贴一张图吧:
    这里写图片描述
    PS:存在的问题:①接口改动时,不易被识别。②维护困难,不便于查找。③前端开发不能进行测试。(如果还要写缺点,有5K+字可以写出来,就省略了哈)
  2. 在我开发第二个APP的后端时,先自己写了一个简易的app接口管理系统,用来后端发布接口,以及前端人员查看。效果如图:
    这里写图片描述
评论 8
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值