API 入门：让系统安全地交流

API 入门：让系统安全地交流

API 是不同软件之间约定好的沟通方式。前端、移动端、后台服务和第三方系统，都可以通过 API 交换数据与能力。

API 的基本组成

一次接口调用通常包含请求地址、请求方法、请求头、请求参数和响应结果。

• GET：读取资源。
• POST：创建资源或触发动作。
• PATCH：更新资源的一部分。
• DELETE：删除资源。

认证与安全

涉及用户或管理权限的 API 必须进行身份认证和授权。不要把密钥写在前端代码中，也不要把密码、令牌和个人信息写入普通日志。

实践建议

1. 使用稳定的版本前缀，例如 /api/v1。
2. 为错误返回明确的错误码和可读消息。
3. 对分页、排序、筛选参数设置上限。
4. 为写入接口设计幂等策略。

常见问题

401 通常表示未认证或令牌过期；422 通常表示请求参数不符合接口约定。