# API（Application Programming Interface）

> 造物笔记 · 资料版本 content-2200e76981

**一句话**：API 是一个程序对外提供的调用约定，写明怎么发请求、要带什么、会返回什么。

**大白话**：API 像餐厅的外卖菜单：能点哪些菜、每道菜要选什么口味、多少钱、会送来什么，都写得清清楚楚，你照着下单就行，不用走进后厨。

**比喻的边界**：菜单上有的菜一般都能点，API 却可能要求先登录或带密钥、限制调用次数，还会随版本变化；文档和实际不一致时，以真实请求的结果为准去排查。

**容易误解**：API 就是一个网址。 → 其实：Web API 通常通过网址访问，但它包括请求方式、参数、认证和返回格式这一整套约定；代码库、操作系统也提供 API，不一定要联网。

**专业理解**：API 是软件对外开放能力的约定。Web 开发里常说的 API 多是通过 HTTP 访问的接口，由地址、方法、参数、请求头（常含认证信息）和响应格式组成，数据多用 JSON。浏览器本身也提供大量 API，比如本地存储、定位，供页面里的 JavaScript 调用。

## 可以直接用的话术

- 开始做：我要给商品列表做一个接口，前端需要{{要返回的字段}}。先帮我写出接口地址、请求方式和返回的样子，我确认后再写代码，写完告诉我怎么在浏览器或终端里请求一次确认返回正确。
- 出错了：我调用天气接口一直返回 “invalid api key”，但我确认复制的是完整的 key。我怀疑是请求头的名字或位置写错了，先帮我对照接口文档检查我的请求写法。贴出来的代码里 key 已换成 ***。
- 想做深：我的商品接口现在一次返回全部商品，以后可能有几千条。帮我给列表接口加上分页，先说明参数怎么设计、返回里要加哪些信息、前端要跟着改什么，确认后再写。

## 来源

- [MDN：API（术语表）](https://developer.mozilla.org/en-US/docs/Glossary/API)（核对 2026-09-26）
