在日常开发中我们经常会接触到 API。比如网站查询快递物流信息App 获取天气数据系统发送短信验证码电商平台查询订单状态用户登录时进行身份信息校验程序获取 IP、地址、地图等数据这些功能背后很多都离不开 API。对于刚接触后端开发、接口开发或者第三方服务的开发者来说API 这个概念并不复杂。真正需要理解的是API 到底是什么、一次 API 请求经历了什么、接口参数怎么设计、返回结果怎么看以及实际项目中应该如何调用 API。本文从实际开发的角度对这些问题做一个完整梳理。一、API 到底是什么API 是Application Programming Interface的缩写中文一般称为“应用程序编程接口”。简单来说API 可以理解为不同软件系统之间进行数据交互的一种约定。举个比较容易理解的例子。假设我们正在开发一个电商网站网站本身并不保存快递公司的全部物流数据。当用户输入运单号之后网站需要获取物流轨迹。这时候系统可以向物流数据服务发送一个 API 请求请求 运单号 SF123456789 返回 { status: success, tracking_number: SF123456789, tracking_status: 运输中, latest_event: 包裹已到达配送中心 }网站拿到数据以后再把结果展示给用户。整个过程可以简单理解为用户 ↓ 前端页面 ↓ 业务服务器 ↓ API 接口 ↓ 数据服务 ↓ 返回 JSON 数据 ↓ 业务服务器处理 ↓ 前端展示因此API 并不是一个具体的软件而是一套让不同程序能够进行通信的接口规范。二、API 的基本组成一个完整的 API 接口通常会涉及以下几个部分1. 接口地址 URLURL 用来告诉程序我要访问哪个接口例如https://api.example.com/v1/query其中https://表示使用 HTTPS 协议。api.example.com表示接口服务器地址。/v1/query表示具体的接口路径。实际项目中一个 API 服务通常会包含多个接口例如/v1/user /v1/order /v1/product /v1/query不同路径对应不同的业务功能。2. 请求方法常见的 HTTP 请求方法包括方法常见用途GET获取数据POST提交数据PUT修改数据DELETE删除数据例如GET /v1/user/10001可以表示获取 ID 为 10001 的用户信息。而POST /v1/user则可能用于创建一个新的用户。实际开发中最常见的还是 GET 和 POST。三、GET 和 POST 有什么区别这是 API 开发中非常基础但也非常重要的一个问题。GET 请求GET 通常用于查询数据。例如GET /v1/weather?cityTokyo其中cityTokyo就是请求参数。完整请求可以理解为请求地址 https://api.example.com/v1/weather?cityTokyo服务器收到请求后根据 Tokyo 查询对应数据。POST 请求POST 更常用于提交数据。例如POST /v1/user Content-Type: application/json请求 Body{ name: Tom, email: tomexample.com }服务器收到数据以后进行处理。因此可以简单记忆GET 更偏向“我要数据”POST 更偏向“我提交数据给你处理”。当然实际 API 设计并不能只靠这一句话判断具体还要根据接口的业务语义和设计规范来决定。四、API 为什么经常返回 JSON如果你使用过各种 API应该会发现一个非常常见的返回格式{ code: 200, message: success, data: { name: Tom, age: 25 } }这里使用的是 JSON。JSON 全称是JavaScript Object Notation它是一种轻量级的数据交换格式。相比传统的复杂数据格式JSON 的结构比较直观因此非常适合 API 数据传输。例如{ name: Tom, age: 25, city: Tokyo }可以直接理解为姓名Tom 年龄25 城市Tokyo在 Java、Python、PHP、Go、JavaScript 等语言中都有成熟的 JSON 解析工具。五、一个 API 请求通常包含哪些参数以一个查询接口为例POST /v1/query可能需要传递{ keyword: ABC123, type: express }这里keyword表示查询关键词。type表示查询类型。不同 API 的参数设计不同但通常可以分为几类。Query 参数例如?page1size20常用于分页、筛选、排序等。Path 参数例如/users/10001其中10001就是资源 ID。Body 参数例如{ username: Tom, password: 123456 }通常用于 POST、PUT 等请求。Header 参数例如Content-Type: application/json Authorization: Bearer xxxxxHeader 通常用于描述请求类型、身份认证、客户端信息等。六、API Key 是什么很多第三方 API 在调用之前都要求开发者申请 API Key。例如Authorization: Bearer YOUR_API_KEY或者api_keyYOUR_API_KEYAPI Key 本质上是一种身份识别凭证。服务器收到请求以后可以通过 API Key 判断是谁调用的 是否有权限 调用了什么接口 调用次数是多少 是否超过限制因此API Key 不应该直接暴露在前端页面中。例如不建议把const apiKey xxxxxxxxxxxx;直接写在公开网页的 JavaScript 中。因为浏览器中的代码最终都会发送到用户设备用户有可能通过开发者工具看到相关信息。更合理的方式是前端 ↓ 自己的后端服务器 ↓ 第三方 API由后端服务器保存 API Key。七、API 调用失败应该怎么排查实际开发中API 最大的问题往往不是“不会调用”而是为什么明明按照文档写了结果还是报错这时候建议按照下面的顺序排查。第一步检查 URL首先确认接口地址有没有写错。例如https://api.example.com/v1/query不要误写成https://api.example.com/query接口路径不同服务器可能直接返回 404。第二步检查请求方法文档要求POST你却使用GET即使 URL 正确也可能无法正常调用。第三步检查 Header例如接口要求Content-Type: application/json那么请求 Body 就应该按照 JSON 格式发送。如果还要求Authorization: Bearer YOUR_API_KEY也必须正确传递认证信息。第四步检查参数例如文档规定keyword必填 type必填却只提交{ keyword: ABC123 }那么接口很可能返回参数错误。第五步查看 HTTP 状态码常见状态码包括状态码含义200请求成功201创建成功400请求参数错误401未认证或认证失败403没有权限404接口或资源不存在429请求次数过多500服务器内部错误503服务暂时不可用例如401优先检查 API Key。如果是400则优先检查请求参数。如果是500则需要进一步查看服务端日志或者接口服务状态。八、使用 Python 调用 API下面用一个通用示例说明 API 的基本调用方式。import requests url https://api.example.com/v1/query headers { Authorization: Bearer YOUR_API_KEY, Content-Type: application/json } data { keyword: ABC123 } response requests.post( url, headersheaders, jsondata ) print(response.status_code) print(response.json())如果接口返回{ code: 200, message: success, data: { result: example } }那么就可以进一步处理result response.json() if result[code] 200: print(result[data]) else: print(result[message])实际项目中还应该增加超时、异常处理、重试等机制。例如try: response requests.post( url, headersheaders, jsondata, timeout10 ) response.raise_for_status() result response.json() print(result) except requests.RequestException as e: print(API 请求失败, e)这样比简单地调用接口更加可靠。九、JavaScript 调用 API如果是前端开发也经常会使用fetch()。例如fetch(https://api.example.com/v1/query, { method: POST, headers: { Content-Type: application/json }, body: JSON.stringify({ keyword: ABC123 }) }) .then(response response.json()) .then(data { console.log(data); }) .catch(error { console.error(error); });不过需要特别注意前端直接调用第三方 API 时要考虑 CORS、API Key 暴露、接口权限等问题。如果接口属于敏感业务通常更建议由后端进行调用。十、API 文档应该怎么看很多开发者第一次看到 API 文档会觉得参数特别多。实际上可以重点关注下面几个部分1. 请求地址 2. 请求方法 3. 请求 Header 4. 请求参数 5. 参数类型 6. 是否必填 7. 返回参数 8. 错误码 9. 调用限制 10. 示例代码例如接口名称数据查询 请求方式POST 请求地址 /v1/query 请求参数 keyword string 必填 type string 可选那么首先就可以把它转换成自己的调用代码。不要一开始就把整篇 API 文档全部看完。先找到“怎么请求”和“传什么参数”通常是最快的上手方式。十一、API 接口设计时需要注意什么如果你不是调用 API而是在自己开发 API那么需要考虑的问题会更多。1. 统一返回结构例如{ code: 200, message: success, data: {} }成功和失败都尽量保持统一结构可以降低前端处理成本。2. 合理设计错误码不要所有错误都返回error可以根据实际业务进行细分40001 参数错误 40002 参数缺失 40101 身份认证失败 40301 无访问权限 42901 请求频率超限这样更方便排查问题。3. 做好接口版本控制例如/v1/user /v2/user当接口发生较大的结构变化时可以通过版本号兼容旧客户端。4. 做好限流开放 API 后如果没有任何限制接口可能被大量请求。因此通常需要设置每秒请求次数 每天调用次数 单用户调用次数 IP 请求限制对于开放平台来说限流是非常重要的一环。十二、API 和 SDK 有什么区别这个问题也经常被问到。简单来说API 是接口规范SDK 是对 API 的进一步封装。例如一个服务提供HTTP API开发者需要自己处理URL Header 参数 HTTP 请求 JSON 解析 异常处理如果服务商同时提供 Python SDK那么开发者可能只需要client.query(ABC123)SDK 把大量底层工作封装起来了。因此可以理解为API ↓ 定义怎么通信 SDK ↓ 把通信过程封装成开发者更容易使用的代码十三、API 在实际项目中的应用API 并不只是“查询数据”。在实际项目中API 的应用范围非常广。数据查询例如天气 物流 地图 地址 汇率 IP 商品用户服务例如登录 注册 短信验证码 身份信息校验 用户资料查询企业系统例如订单系统 ERP CRM 库存系统 支付系统 物流系统AI 应用现在很多 AI 应用同样是通过 API 进行调用。基本流程自己的程序 ↓ 发送请求 ↓ AI API ↓ 模型处理 ↓ 返回结果 ↓ 自己的程序继续处理因此如果想开发一个 AI 应用、数据查询平台或者自动化工具API 基础是非常值得掌握的一项能力。十四、写 API 调用代码时不要只关注“能不能跑”刚开始学习 API 时很多人的目标是请求成功就行。但到了实际生产环境关注点应该进一步扩大到稳定性 安全性 性能 错误处理 日志 超时 重试 限流 权限 数据校验例如一个接口偶尔出现网络超时如果代码没有任何异常处理response requests.get(url)整个程序可能直接报错。如果增加timeout10并结合异常捕获、重试机制就能明显提高程序的稳定性。所以“能调用 API”和“把 API 用好”其实是两个不同阶段。十五、总结API 可以简单理解成不同软件系统之间进行数据和功能交互的一座桥梁。理解 API首先掌握这几个概念URL HTTP Method Header Parameter JSON API Key HTTP Status Code Error Code然后再逐步学习认证 权限 限流 分页 版本控制 异常处理 重试机制 接口安全对于初学者来说不需要一开始就研究非常复杂的 API 架构。可以先找一个公开 API按照阅读接口文档 ↓ 确定 URL ↓ 确定请求方法 ↓ 填写参数 ↓ 发送请求 ↓ 查看 JSON ↓ 处理返回结果完整走一遍。当你真正完成几次 API 调用之后很多原本看起来比较抽象的概念都会变得非常直观。API 的核心并不神秘本质上就是按照双方约定的规则发送请求再按照约定的格式接收和处理数据。
--9.4 全章综合复盘)
![[光学原理与应用-521]：对光的错误理解与纠偏](http://pic.xiahunao.cn/yaotu/[光学原理与应用-521]：对光的错误理解与纠偏)
