不懂技术如何看懂API接口文档?聪明的你一看就会

api游戏接口到底怎么对接

Application Programming Interface

API是什么

api接口英文全称“ Application Programming Interface ” 通俗点说就是:应用程序编程接口。它是操作系统最基本的东西,通过它可以进行计算机硬件操作。如今各行业生活中随处可见,有水电费、煤气费、固话宽带、交通罚款都能在手机上完成支付,从而免去一系列繁琐操作。今年的新冠统计数据看新闻的每小时几乎都会有统计确诊数据等信息,然而数据的背后都是API默默的在运行。

api游戏接口到底怎么对接
api游戏接口到底怎么对接

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

api游戏接口到底怎么对接
api游戏接口到底怎么对接

API文档 英文" API developer doc "对于开发者来说最头疼的就是除了开发api接口,还要规范的写好 API文档

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

1、接口描述

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

2、接口地址

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

3、请求方法

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

4、请求参数

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

5、响应内容

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

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

6、错误代码

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

7、实例

实际调用时的响应的内容。

到此无论是api游戏接口还是其他任何接口对接应该都会有一定的了解 做产品经理是难的,因为要懂得的东西太多了,而做产品经理也是容易的,因为有些东西根本不需要精通,只要略懂就可以了,基本上你能把以上几个部分搞明白,看懂一个API文档是没有问题的,和技术人员对接的时候也不会再被吐槽是个傻逼。总之,产品经理做得好就风风光光,做不好会人人喊打,根本就是条不归路,而我们已经在这条路上越走越远……

评论0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
登入/注册
Administrator Login
没有账号? 忘记密码?
zh_CNChinese
thThai viVietnamese en_USEnglish ko_KRKorean zh_CNChinese