API & Endpoint
API 与接口端点
API 是软件之间通信的一套规则；接口端点则是 API 里的一个地址和一项操作。
另一个例子
应用调用 GET /api/projects，并按 API 文档指定的响应格式获取项目数据。
主要部分
- 01来源请求
- 02解析或处理节点
- 03响应、耗时与失败状态
什么时候用
API 契约应清楚写出方法、数据格式规则（Schema）、错误、权限和版本。
什么时候不要用
不要暴露内部数据库结构，也不要公开可能改变的实现细节。
代码里的名称
HTTP method + route + schema 上线前要检查
检查接口约定、任何情况下都不能破坏的规则、授权与输入限制。测试重试、重复执行只生效一次、超时与部分失败。验证数据完整性、兼容性、监控、恢复与回到上一版。
预期结果：为这套系统设计或检查 API 与接口端点 (API & Endpoint)，并让数据保持正确、安全且容易维护。 用户场景：应用调用 GET /api/projects，并按 API 文档指定的响应格式获取项目数据。 技术概念或控制措施：API 与接口端点 (API & Endpoint)。 适用理由：API 契约应清楚写出方法、数据格式规则（Schema）、错误、权限和版本。 不应使用的情况：不要暴露内部数据库结构，也不要公开可能改变的实现细节。 工程要求：定义输入、输出、接口约定，以及任何情况下都不能破坏的规则。说明授权与输入检查范围。定义失败、超时、重试和重复执行只生效一次的规则。也要定义数据迁移与兼容限制。 运营要求：加入监控信号与隐藏敏感数据的日志。设置容量上限并写好操作手册。测试恢复与回到上一版的流程。 验收标准：接口约定与失败路径测试通过。重试或部分失败时，数据与授权规则仍正确。性能上限、监控、恢复与回到上一版的方法都已验证。 证据与限制（证据边界）：没有一份官方标准能涵盖全部内容。不同团队、平台或框架的用法可能不同。 待确认：程序运行环境、数据位置、流量形态、数据一致需求和安全边界。也要确认兼容周期、服务目标（SLO）与恢复上一版的限制。
检查这份需求
请 AI 编程助手检查当前如何使用 API 与接口端点 (API & Endpoint)。 定义：API 是软件之间通信的一套规则；接口端点则是 API 里的一个地址和一项操作。 生产环境检查：检查接口约定、任何情况下都不能破坏的规则、授权与输入限制。测试重试、重复执行只生效一次、超时与部分失败。验证数据完整性、兼容性、监控、恢复与回到上一版。 修改程序前，先列出看到的证据、缺口、严重程度，以及最小且安全的修正。