{"repo": "anh627/easygame", "files": {"docs/.vitepress/theme/components/appendix/api-intro/ApiFunctionVsHttp.vue": {"64900140d8920e20989a8ac4227900703b4f73e8": {"t": 1785746538.0167036, "n": 17080, "h": "055825151fe86cb8", "c": "\n\n\n\n\n"}, "78db819e841b2c0117cf1e09ceb18bb2a17b65a2": {"t": 1785765449.108592, "n": 17080, "h": "055825151fe86cb8", "c": "\n\n\n\n\n"}}, "docs/zh-cn/appendix/4-server-and-backend/api-intro.md": {"64900140d8920e20989a8ac4227900703b4f73e8": {"t": 1786067813.1449256, "n": 6234, "h": "0df34a2201308e92", "c": "# API 入门:从零理解\"程序之间的对话\"\n\n::: tip 🎯 核心问题\n**什么是 API?** 这就像问:餐厅的菜单怎么设计,客人一看就懂?服务员怎么记单,不会出错?API 解决的就是\"程序之间如何对话\"的问题。你写代码的第一天就在用 API,只是你可能没意识到。\n:::\n\n---\n\n## 0. 新手常见的三个困惑\n\n**困惑一:API 是很高深的东西吗?**\n\n很多人一听到 API,就觉得是高级工程师才能理解的概念。其实你早就用过 API 了:\n\n```python\nlen(\"hello\") # 这就是 Python 提供的 API\nopen(\"file.txt\") # 这也是 API\nrequests.get(url) # 这还是 API\n```\n\n**困惑二:Web API 和普通 API 有什么区别?**\n\n| 类型 | 调用对象 | 通信方式 | 典型场景 |\n| :--- | :--- | :--- | :--- |\n| **函数 API** | 本地代码 | 函数调用 | `len()`, `open()` |\n| **操作系统 API** | 操作系统 | 系统调用 | 读写文件、创建进程 |\n| **Web API** | 远程服务器 | HTTP 请求 | 调用 AI 模型、获取天气 |\n\n**困惑三:我该用 HTTP 还是 SDK?**\n\n```python\n# HTTP 方式:自己处理所有细节\nimport requests\nresponse = requests.post(\n \"https://api.deepseek.com/v1/chat/completions\",\n headers={\"Authorization\": \"Bearer sk-xxx\"},\n json={\"model\": \"deepseek-chat\", \"messages\": [...]}\n)\nresult = response.json()[\"choices\"][0][\"message\"][\"content\"]\n\n# SDK 方式:管家帮你处理\nfrom openai import OpenAI\nclient = OpenAI(api_key=\"sk-xxx\")\nresponse = client.chat.completions.create(\n model=\"deepseek-chat\",\n messages=[...]\n)\nresult = response.choices[0].message.content\n```\n\n---\n\n## 1. API 的本质:插头与插座\n\n**API**(Application Programming Interface,应用程序编程接口)就是\"程序之间对话的约定\"。\n\n### 1.1 用电器来类比\n\n| 概念 | 电器类比 | API 对应 |\n| :--- | :--- | :--- |\n| **接口** | 插座形状 | 函数签名 / URL |\n| **输入** | 电流输入 | 函数参数 / 请求体 |\n| **输出** | 电器工作 | 返回值 / 响应体 |\n\n### 1.2 三种 API 形态对比\n\n\n\n### 1.3 函数 API vs HTTP API 的区别\n\n很多初学者会困惑:函数 API 和 HTTP API 到底有什么区别?看文档时该如何区分?\n\n\n\n### 1.4 不同类型的 API 文档怎么看\n\n面对不同类型的 API 文档,关注重点各不相同:\n\n\n\n---\n\n## 2. 一次完整的 API 调用\n\n👇 **动手试试看**:点击下方按钮,观察一次完整的 API 请求-响应流程:\n\n\n\n### 2.1 API 调用的四个阶段\n\n| 阶段 | 发生了什么 | 电器类比 |\n| :--- | :--- | :--- |\n| **请求** | 客户端向服务器发送请求 | 按下开关 |\n| **传输** | 请求通过网络传输到服务器 | 电流通过电线 |\n| **处理** | 服务器处理请求并返回数据 | 电器开始工作 |\n| **响应** | 客户端接收并处理返回结果 | 灯泡发光 |\n\n### 2.2 餐厅类比\n\n| 餐厅角色 | API 对应 | 说明 |\n| :--- | :--- | :--- |\n| **菜单** | API 文档 | 告诉你有哪些\"菜\"可以点 |\n| **服务员** | HTTP 协议 | 标准化的\"对话方式\" |\n| **后厨** | 服务端 | 按\"订单\"处理请求 |\n| **上菜** | 响应 | 把结果返回给\"客人\" |\n\n---\n\n## 3. HTTP 方法:你是在\"问\"还是在\"做\"?\n\n调用 Web API 时,你需要告诉服务器你想做什么。这就是 HTTP 方法的由来。\n\n### 3.1 用餐厅点餐来理解\n\n| 场景 | 现实中你会怎么说? | 对应的 HTTP 方法 |\n| :--- | :--- | :--- |\n| 你想知道今天有什么菜 | \"服务员,菜单给我看看\" | **GET** - 纯\"问\",不改数据 |\n| 你想点一份宫保鸡丁 | \"给我来份宫保鸡丁\" | **POST** - \"做\"件事,创建数据 |\n| 你想换一道菜 | \"把宫保鸡丁改成糖醋里脊\" | **PUT** - 替换数据 |\n| 你想改口味 | \"宫保鸡丁不要放花生\" | **PATCH** - 部分修改 |\n| 你不想要了 | \"算了,那道菜不要了\" | **DELETE** - 删除数据 |\n\n\n\n::: warning 关于幂等性\n**幂等性**:多次执行结果是否相同?\n\n- **幂等的操作**(GET/PUT/DELETE):点 10 次和点 1 次,结果一样\n- **不幂等的操作**(POST):点 10 次,可能创建 10 个订单\n\n**解决方案**:POST 操作用唯一 ID 校验,避免重复处理。\n:::\n\n### 3.2 HTTP 方法速查表\n\n| 方法 | 用途 | 幂等性 | 安全性 | 典型场景 |\n| :--- | :--- | :--- | :--- | :--- |\n| **GET** | 获取资源 | 是 | 是 | 查询列表、查看详情 |\n| **POST** | 创建资源 | 否 | 否 | 新增用户、提交订单 |\n| **PUT** | 全量更新 | 是 | 否 | 替换整个用户资料 |\n| **PATCH** | 部分更新 | 否 | 否 | 只修改昵称 |\n| **DELETE** | 删除资源 | 是 | 否 | 删除用户、取消订单 |\n\n---\n\n## 4. HTTP 状态码:服务器在告诉你什么?\n\n服务器回复时,会先返回一个状态码,告诉你请求是否成功。\n\n### 4.1 状态码分类\n\n\n\n### 4.2 常见状态码详解\n\n| 状态码 | 含义 | 典型场景 | 客户端处理 |\n| :--- | :--- | :--- | :--- |\n| **200 OK** | 成功 | 请求正常处理 | 展示数据 |\n| **201 Created** | 创建成功 | POST 请求成功创建资源 | 跳转到新资源 |\n| **400 Bad Request** | 请求格式错误 | 参数缺失或格式不对 | 检查参数 |\n| **401 Unauthorized** | 未认证 | 没有提供有效的 API Key | 引导用户登录 |\n| **403 Forbidden** | 无权限 | API Key 没有访问该资源的权限 | 提示权限不足 |\n| **404 Not Found** | 不存在 | 请求的地址或资源不存在 | 检查 URL |\n| **429 Too Many Requests** | 请求过多 | 超过了速率限制 | 稍后重试 |\n| **500 Internal Server Error** | 服务器错误 | 服务端出了问题 | 提示用户稍后重试 |\n\n👇 **动手试试看**:点击下方按钮,了解常见状态码的含义:\n\n\n\n---\n\n## 5. HTTP vs SDK:自己跑腿还是让管家代办?\n\n### 5.1 两种调用方式对比\n\n| | 🏃 **HTTP API** | 🤵 **SDK** |\n| :--- | :--- | :--- |\n| **比喻** | 自己跑腿 | 管家代办 |\n| **优点** | ✓ 所有语言都能用
✓ 完全控制请求细节
✓ 无需额外依赖 | ✓ 代码简洁易读
✓ 自动处理鉴权
✓ 内置错误重试 |\n| **缺点** | ✗ 需要处理所有细节
✗ 代码冗长易出错 | ✗ 需要安装依赖
✗ 可能有版本问题 |\n| **代码示例** | `requests.post(url, json=..., headers={...})` | `client.chat.completions.create(...)` |\n\n### 5.2 如何选择?\n\n| 场景 | 推荐方式 | 原因 |\n| :--- | :--- | :--- |\n| **快速开发** | SDK | 自动处理鉴权、错误、重试 |\n| **学习原理** | HTTP | 理解底层机制 |\n| **不支持的语言** | HTTP | 任何语言都能用 |\n| **需要定制** | HTTP | 灵活控制每个细节 |\n\n::: tip 💡 建议\n**能用 SDK 就用 SDK**,把麻烦事留给库,把时间留给自己。\n:::\n\n---\n\n## 6. 如何阅读 API 文档?\n\nAPI 文档就像说明书和菜单的结合体。你不需要从头读到尾,只需要学会\"查字典\"。\n\n### 6.1 文档阅读清单\n\n打开任何一个 API 文档(比如 OpenAI 或 DeepSeek),你只需要找这几样东西:\n\n\n\n| 项目 | 说明 | 示例 |\n| :--- | :--- | :--- |\n| **Base URL** | API 的根地址 | `https://api.deepseek.com` |\n| **Authentication** | 如何证明身份 | `Authorization: Bearer sk-xxx` |\n| **Endpoints** | 具体的接口列表 | `/v1/chat/completions` |\n| **Parameters** | 必填/可选参数 | `model`(必填)、`temperature`(可选) |\n| **Response** | 返回数据结构 | `{\"choices\": [...]}` |\n\n### 6.2 阅读文档的步骤\n\n1. **找到 Base URL** - 这是所有请求的前缀\n2. **看懂认证方式** - API Key 放在 Header 还是 Query?\n3. **找到需要的 Endpoint** - 你要调用的具体接口\n4. **查看请求参数** - 哪些必填?哪些可选?\n5. **理解返回格式** - 数据是如何组织的?\n\n---\n\n## 7. 动手练习:模拟 API 调用\n\n光说不练假把式。这里有个模拟 API,你可以随便填参数、随便改地址,看看会发生什么。\n\n\n\n试着触发以下场景:\n- ✅ **成功请求**:填入正确的 Endpoint 和 API Key\n- ❌ **401 错误**:不填 API Key,看看服务器怎么拒绝你\n- ❌ **404 错误**:填一个不存在的地址\n\n---\n\n## 8. 小结\n\n::: info 核心要点\n1. **API 就是传声筒**,帮你把话传给另一段代码或远程服务器\n2. **你早就用过 API 了**,从 `len()` 到 `open()` 都是 API\n3. **Web API 是超能力**,让你调用千里之外的超级电脑\n4. **SDK 是好管家**,能用 SDK 就别自己跑腿\n5. **看文档找三样**:地址、鉴权、参数\n:::\n\n在 AI 编程的时代,你只需要记住这几个核心概念。剩下的细节,IDE 和 AI 助手会帮你处理。\n\n---\n\n## 名词速查表\n\n| 名词 | 全称 | 解释 |\n| :--- | :--- | :--- |\n| **API** | Application Programming Interface | 应用程序编程接口,定义了软件之间如何交互 |\n| **Web API** | - | 基于 HTTP 协议的 API,用于网络通信 |\n| **Endpoint** | - | 端点,API 的具体地址 |\n| **HTTP** | HyperText Transfer Protocol | Web API 使用的通信协议 |\n| **GET** | - | 获取资源的方法 |\n| **POST** | - | 提交数据的方法 |\n| **SDK** | Software Development Kit | 软件开发工具包,封装了底层 API 调用 |\n| **URL** | Uniform Resource Locator | API 的网络地址 |\n| **JSON** | JavaScript Object Notation | 常用的数据格式 |\n| **Authentication** | - | 验证身份的过程 |\n| **Status Code** | - | HTTP 响应中的状态码 |\n| **Request** | - | 请求 |\n| **Response** | - | 响应 |\n| **Header** | - | HTTP 头,包含元信息 |\n| **Payload** | - | 请求或响应的实际数据 |\n| **Rate Limit** | - | 速率限制 |\n| **Idempotent** | - | 幂等,多次执行结果相同 |\n| **REST** | Representational State Transfer | 一种 API 架构风格 |\n| **RPC** | Remote Procedure Call | 远程过程调用 |\n| **GraphQL** | - | 一种查询语言 API |\n| **gRPC** | - | Google 开发的高性能 RPC 框架 |\n"}}}}