如何看懂接口文档

什么是API?

API：应用程序接口（API：Application Program Interface），是一组定义、程序及协议的集合，通过 API 接口实现计算机软件之间的相互通信。

接口：就是我们拿到信息的途径，我们可以简单地认为“接口定义了功能”
eg：APP，微信，QQ，知乎我们通过各种APP获得所要的知识，这些APP就可以看作是接口

接口文档包括啥？

通常来说，一份API接口文档包含多个API单个信息，单个API的信息包含以下信息：

1、接口描述：

*这个接口是用来干嘛的(意为对面说明他们能给你什么服务），以及相关的规则

登录信息服务

2、接口地址：

*_(从哪里拿到信息）以网址的形式展现，你通过发送请求给这个网址来对接口进行交互操作_

localhost:8080/login

3、请求方法：

（要用特定的方式去获取信息内容,常用的有post和get两种方式_，_一个是读接口(常用get)一个是写接口(常用post)）

get/post

4、请求参数：

*请求该接口时，需要提供的参数，参数属性包括名称、类型、是否必填、描述等

（要拿他们给的信息，总要告诉他们你是谁，怎么证明你是谁之类的东西；例如：我要查话费，那我就要给对端，我的姓名，我的手机号之类的内容。姓名和手机号就是请求参数，下面的参数就有两个：area和key）
_area和key）

5、权限说明：

接口访问的权限（例如功能型或数据型）。

6、返回参数：接口正常响应后，返回的内容

7、错误代码：接口请求失败后，返回的错误代码

查不出来/你给的信息有误时，对面会给你错误的提示，比如人家查话费接的姓名要中文的，你告诉他你的名字叫Tony，他们就会提示你"姓名不符合规范"，并给这个提示一个代号"9527")
![]

(https://cdn.nlark.com/yuque/0/2019/jpeg/507364/1571997188217-51444291-7040-4518-b85a-13905af409d3.jpeg#align=left&display=inline&height=227&originHeight=197&originWidth=720&search=&size=0&status=done&width=830)

面对复杂API文档时怎么办？参考https://zhuanlan.zhihu.com/p/69322441