API 是什么

API 是什么?不用写代码也能先理解这个概念

本篇内容导航
  1. 请求和响应
  2. 为什么需要 API
  3. API Key 不是普通密码
  4. API 文档真正告诉你的是什么
  5. 第一次看 API 文档,先找这 5 项

API 经常出现在开发文档里,但它并不神秘。可以先把它理解成:两个软件之间约定好的沟通方式。

请求和响应

一步你实际在做什么常见问题
选择接口确认 URL、HTTP 方法和这个接口解决什么任务把“整个 API”当成一个单一地址
发送请求带上参数、请求体和必要的认证信息字段名、格式或认证方式不符合文档
读取响应先看状态码,再看返回的数据或错误内容只看 JSON,不看 401/403/429/5xx

真正开始调用时,最重要的资料不是二手教程,而是该服务当前的官方 API 文档:它会定义接口地址、参数、认证、限制和错误响应。

一方按照约定发送请求,另一方返回数据或执行操作。至于请求里要带什么、返回什么格式,就由 API 文档规定。

为什么需要 API

如果每个系统都要直接操作对方内部代码,协作会非常混乱。API 把可用能力整理成边界清楚的接口。

API Key 不是普通密码

很多服务用 API Key 标识调用方。它通常应该保存在安全位置,不要直接写进公开网页或提交到公开代码仓库。

API 文档真正告诉你的是什么

通常会写明地址、请求方法、参数、认证方式、返回结构和可能出现的错误。调用失败时,先检查是否按文档发送了正确字段,比不断改代码碰碰运气更有效。

同一个服务可能同时提供网页、手机应用和 API;API 是给程序之间使用的接口,不是另一个“隐藏网页”。

第一次看 API 文档,先找这 5 项

  1. Endpoint:请求发到哪里。
  2. Method:是 GET、POST 还是其他方法。
  3. Authentication:需要什么凭据,凭据应该放在哪里。
  4. Parameters / Body:哪些字段必填,格式是什么。
  5. Response / Errors:成功会返回什么,常见失败状态和限制是什么。