API 基础知识

API 属于软件开发通用型知识，网上有非常多的教程资料，本篇只做基础的介绍认知，如若提供的内容不足以支持你的学习，那么可以自行到网上搜索更加详细的教程内容。

什么是 API

API (Application Programming Interface) 即应用程序编程接口 API 是由软件开发商根据特定的接口规则（通常是 HTTP 和 REST）定义好的可以被其他软件调用，实现不同软件之间数据交互的工具。例如：气象局的软件有每天的天气数据，你手机中的天气查询软件就是通过 API 与气象局“对话”，获取当前最新的气象数据并显示在手机上

推荐第三方 API 集合

拥有丰富种类的 API 超市，你可以在其中找到适合你业务的 API

Apifox：https://apifox.com/apihub/
腾讯轻联：https://qinglian.tencent.com/apps/list/## 如何阅读 API 接口文档一般 API 都会有相应的接口文档，接口文档一般包括如下这几部分内容供开发者阅读使用，在使用某个 API 之前请认真阅读接口文档，按照文档要求进行调试、配置。

Tips： 一般 API 都需要注册 API 提供商的开发者账号，以获得使用 API 的资格（appid、appsecret 之类的）以及调用次数。

接口描述

简单描述接口的逻辑和作用。例如说明这是一个发送消息的接口、查询天气的接口

请求方法

常见的请求方法为 GET 和 POST ，请求方式的解释如下所示：

GET：向提供 API 接口的第三方软件查询单条或者多条数据
POST：向提供 API 接口的第三方软件查询单条或者多条数据，也可以修改、删除第三方软件的数据### 接口地址接口地址可以理解为是一个以 http / https 开头的网址，一般被称为 URL ，在调用 API 的时候，相当于用户就是给这个网址发起请求发送参数，然后这个网址给用户返回了相应的结果

请求参数

常见的请求参数分为：路径参数（PATH/Params），请求头（Header 参数），请求体（Body 参数），这些参数是用户发送请求时一般需要给第三方软件提供的例如“身份识别信息”、“要请求的内容标识”等内容，这样第三方软件才能够按照用户的要求返回相应的结果。
路径参数（PATH/Params）：

请求头（Header 参数）：

请求体（Body 参数）：常见的请求体是一个 JSON 对象，如下方的一对 {} 中的内容

响应内容

响应内容指的是发送了请求之后，第三方软件按照请求要求返回的数据结果，了解响应内容主要是了解内容的结构，知道如何从响应结果中进一步获取需要用到的具体数据。常见的响应内容的格式也是一个 JSON 对象。

响应状态码

响应状态码指的是发送请求之后的响应情况，常见的响应情况如下所示，一般第三方 API 还会有自己定义的状态码以及状态码对应的描述。

如何调试 API

调试 API 指的是一般在实际调用 API 之前会进行测试调用，测试一下 API 的调用方法以及返回内容是否符合预期

调试工具 Postman

API 提供商一般会有自己的调试工具，例如 Apifox 的 API 超市的接口文档中就自带调试工具

但我们推荐使用 Postman 这款调试工具来进行 API 的调试，点击此链接 Postman | Download Postman App 进入Postman官网下载页面，选择相应的版本（操作系统及 32位/64位）并安装在 Postman 中按照接口文档的要求选择「请求方式」，复制粘贴「请求地址」，填入「请求参数」，点击 Send 按钮发送请求，即可在下方看到「响应内容」如若返回的内容符合你的预期，那么恭喜你调试成功，你将可以在 Zion 中进行调试配置，完成你的功能开发需求如果调试失败，那么请仔细阅读接口文档，检查是否有内容配置错误，重新配置，或者咨询 API 提供商

API 基础