词条信息

admin
admin
超级管理员
词条创建者 发短消息   

相关词条

热门词条

更多>>
什么是端口?到底是做什么的呢?
端口一般指两种,一种是硬件比如路由器或者交换机的插网线的端口,一种是软件的逻辑的概念,比如http的80端口!...
7种进阶方法让你快速测试端口连通性
Ping是Windows、Linux和Unix系统下的一个检查网络连通性的命令工具,对于大部分互联网用户来说很...
电脑开机,总需要按F1,是什么原因造成的?
一.主板掉电这个说法是行业内的叫法了,一般是主板的CMOS电池没电了导致的。也是最常见的一种提示你按F1的提示...
社保降费对个人有什么影响?
下调城镇职工基本养老保险单位缴费比例是政府给企业发的一个大红包,特别是对于企业来说是一个利好,但是对个人来说有...
车辆“出险”对下年保费的影响,到底有多大?
【出险对交强险的影响】【出险对商业险的影响】车辆“出险”对下年保费的影响,到底有多大?这里有必要先提下车险第三...
解决网 >>所属分类 >> 程序开发    前端开发   

不懂技术如何看懂API接口文档?

标签: API接口

顶[0] 发表评论(0) 编辑词条

很多产品经理刚接触API接口工作时,脑子一片空白,不理解接口(API)是什么,更看不懂接口开发文档,在接口上踩了很多坑。作为一个踩坑踩到步步高升的资深产品经理,我决定来分享一下我的多年经验:作为一个不懂技术的产品经理,该如何看懂接口文档。


目录

API是什么编辑本段回目录


API就好像是一个传输数据的通道,入口需要请求数据,相当于通关密码,而出口需要返回结果。接口的使用方不需要关心接口是如何实现的,只关心能不能拿到接口最后的返回结果。接口的提供方需要定义接口请求参数、响应内容等,还需要关注接口的性能,是否能满足高并发的调用,接口的稳定性如何……总之,API就是一个预先定义的函数。


API文档编辑本段回目录


API接口一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。


1、接口描述


简单描述接口的逻辑和作用


2、接口地址


接口的正式url和接口测试的url,需求方通过调用接口url,获取响应内容


3、请求方法


一般来说,接口最常见的请求方法为GET和POST两种方式,即读接口和写接口。通过这两种方式,实现对数据的增删查改。增删改本质都是写的动作。


4、请求参数


即需要请求的字段名的名称和规则:都是哪些字段,字段的类型是什么,是否必填字段等等


5、响应内容


接口返回的字段名称和规则。


注意:大部分开发往往不会把所有的字段罗列,只会列出比较重要的字段。当你发现,接口文档中没有你需求的字段,别着急找开发,可以看下实例中,有没有需求的字段。


6、错误代码


对接口的错误用代码进行归类,以便能快速找到错误原因,解决问题。


7、实例


实际调用时的响应的内容。做产品经理是难的,因为要懂得的东西太多了,而做产品经理也是容易的,因为有些东西根本不需要精通,只要略懂就可以了,基本上你能把以上几个部分搞明白,看懂一个API文档是没有问题的,和技术人员对接的时候也不会再被吐槽是个傻逼。总之,产品经理做得好就风风光光,做不好会人人喊打,根本就是条不归路,而我已经在这条路上越走越远……

 

 

附件列表


按字母顺序浏览:A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

→我们致力于为广大网民解决所遇到的各种电脑技术问题
 如果您认为本词条还有待完善,请 编辑词条

上一篇到底什么是 API
下一篇PHP调用API接口实现天气查询功能

0
1. 本站部分内容来自互联网,如有任何版权侵犯或其他问题请与我们联系,我们将立即删除或处理。
2. 本站内容仅供参考,如果您需要解决具体问题,建议您咨询相关领域专业人士。
3. 如果您没有找到需要的百科词条,您可以到百科问答提问或创建词条,等待高手解答。

关于本词条的提问

查看全部/我要提问>>