API通用模板

摘要

本文档定义了一个通用的API接口交互模板，适用于灵活用工、企业服务、AI及自媒体运营等领域的系统集成。它规范了API请求的通用请求头、Cookies和响应结构，包括统一的JSON响应体格式（包含code, message, data, error字段），为开发标准化的API服务提供了基础架构参考。

核心要点

• 定义了通用的API请求头，包括Content-Type、Authorization等关键字段。
• 规范了API响应的统一结构，采用{code, message, data, error}的JSON格式。
• 为客户端与服务端之间的数据交互提供了标准化的模板和示例。
• 强调了鉴权Token（Bearer Token）在请求中的使用方式。

关键实体

• API (concept)
• Authorization (concept)
• Bearer Token (concept)
• JSON (concept)

相关内容

• [[wiki-v3与karpathy方案对比分析.md]]
• [[llm上下文窗口与个人知识库构建karpathy方案解析.md]]
• [[个人知识库_v1v2_改造方案.md]]

建议新建页面

• [[API安全与鉴权机制详解]] — 文中涉及Bearer Token和Authorization头，可深入探讨API密钥管理、OAuth2.0等安全实践，与已有实体‘API Key明文泄露’相关。
• [[企业系统集成API设计规范]] — 该模板是通用规范，可扩展到企业服务中微服务架构、内外部API网关设计的具体案例和标准。

---

> 编译时间: 2026-06-21 04:38 | 来源: `zblog-docs/api-15-common-template.md`