什么是 RESTful API
符合 REST 架构风格的 API
RESTful API 具体什么样子
一个 RESTful API 包含以下三方面
- 基本的 URI(统一资源定位符)，如https://api.github.com/users
- 标准的 HTTP 方法，如 GET，POST，PUT(整体替换)，PATCH(部分更新)，DELETE
- 传输的数据媒体类型，如 JSON，XML
现实举例
- GET /users# 获取 user 列表
- GET /users/12# 查看某个具体的 user
- POST /users# 新建一个 user
- PUT /users/12# 更新 id 为 12 的 user
- DELETE /users/12# 删除 user12
GitHub API 示例
GitHub 上 RESTful API 参考示例
仓库地址
RESTful API 设计最佳实践系统应该包含什么
请求设计规范
- URI 使用名词，尽量用复数，如/users
- URI 使用嵌套表示关联关系，如/users/12/repos/5
·GET /repos/:owner/:repo
- 使用正确的 HTTP 方法，如 GET/POST/PUT/DELETE
- 不符合 CRUD 的情况：使用 POST、action、子资源三种方式解决
- Transfer a repository:
POST /repos/:owner/:repo/transfer
- Transfer a repository:
响应设计规范
接口的返回值，参考仓库地址
- 查询
- 分页
- 字段过滤
- 状态码
- 错误处理
安全
- HTTPS
- 鉴权
- 限流
开发者友好
- 文档
- 超媒体
