2016 - 2024

感恩一路有你

api接口调用方法 后端开发完接口才给出接口文档,合理吗?你怎么看?

浏览量:1651 时间:2021-03-11 06:09:57 作者:admin

后端开发完接口才给出接口文档,合理吗?你怎么看?

一个非常好的问题,我是工作多年的Web应用架构师,来回答一下这个问题。欢迎关注我,了解更多IT专业知识。


后端给出接口文档太晚,也合理也不合理,要看具体情况,总有解决方法,我来说一下我的观点。


不合理:成熟的技术团队,重视功能设计,在动手写代码之前已经有了完整的技术文档和功能定义,甚至在TDD测试驱动开发模式中,测试数据已经准备就绪,那么这时接口文档不管写没写,接口逻辑都是已经确定的,整理出来是水到渠成。


合理:多存在于早期小型创业公司,主观客观原因都有。


- 先说主观原因。赶进度、没时间、懒得写,甚至开发前都没做仔细的设计,边做边改,这些原因普遍存在,也实在没啥好办法。


- 客观原因,需求在变,功能跟着变,接口也要变,那么如果写了文档,理所当然也要更新维护啊?我的天哪。


有解决方法吗?建议试试:

1,Swagger接口文档,将文档融合到代码中,让维护文档和修改代码整合为一体,使得修改代码逻辑的同时方便的修改文档说明。


2,Postman接口测试工具,导入导出JSON文件,高效团队协作。Postman支持各种请求方式和配置环境变量,并对返回结果进行测试校验,支持批量自动化运行,可以和自动构建系统集成。

前端嫌我接口分的太多,我该怎么回答?该怎么操作?

我们的框架也是前后台分离。后端接口的多少应该根据业务合理划分,而不是谁觉得多不方便,开发不能只从方便入手。整体上接口设计的多少应从以下几个方面考虑:

1、接口粒度的细分考虑职责单一,还得考虑多个操作是否应该在同一事物中,若在同一事物中接口的粒度可设计大一点。

2、接口的合并问题,当有多次请求不同接口而返回数据量又不大的时候可酌情将接口进行合并。

3、接口的拆解问题,当一次返回数据量过大导致传输慢的时候,根据业务得拆成多个接口,并要分析哪些数据先请求,哪些后请求。

4、接口重复问题,比如PC应用和移动应用用到同一组数据,后台针对PC和移动端应用开发了两个接口,这种情况下可以删除一个接口。

5、接口停止服务问题,举个例子,在618,双11时很多商品有促销活动(提供的接口),当过了这两天,完全可以把此类服务停止减少负荷。

以上是我从实际项目角度做的分析,希望帮助到你,具体到项目中可深入探讨。


API接口有什么作用?

我们常在软件开发或合作中遇到“API”这个词,比如API接口、API调用、API接口函数等等,那么到底什么是API呢?

API用通俗的话说,就相当于大家经常看的科幻电影中的空间站或宇宙飞船与其他航天设备对接的那个开口。别人的航天飞机要跟你对接时,你必须告诉你的空间站的对外接口标准规格,比如接口名称、接口尺寸、接口程序等等,才能保证最终两者顺利通过这个接口建立联系,完成彼此内容的交换。

API的标准说法是Application Programming Interface,即应用程序编程接口。

API是一些预先定义函数,目的是用来提供应用程序与开发人员基于某软件或者某硬件得以访问一组例程的能力,并且无需访问源码或无需理解内部工作机制细节。这个也很好理解,一个标准软件,比如今日头条APP,就可以开放API接口给别人,比如字节跳动公司需要随时了解今日头条APP的用户使用状态,他们就可以让今日头条开发一个名字叫“用户状态/User Status”的API接口,然后字节跳动母公司就通过自己统计软件获取这个“User Status”函数的内容,这样今日头条用户总量、新增用户量、用户活跃状态、热点数据就会在字节跳动的统计软件屏幕上显示出来,而该统计软件不需要知道哪个用户具体发布了哪些内容,如果需要,也需要另外做API接口去调用。

所以,API就是操作系统给应用程序的调用接口,应用程序通过调用操作系统的 API而使操作系统去执行应用程序的命令(动作)。在 Windows 中,系统API是以函数调用的方式提供的。

前端怎么调用api接口?

首先你必须要写一个调用的类,然后这个类里面直接将接口的地址给调用好之后,然后进行连接,再通过其他的方式再调用这个类,就可以使用这个API的接口了。

api接口调用方法 api接口怎么接入 网页调用api接口

版权声明:本文内容由互联网用户自发贡献,本站不承担相关法律责任.如有侵权/违法内容,本站将立刻删除。