RESTful API 简介

什么是 RESTful API?

符合 REST架构风格的 api

RESTful api具体什么样子

• 基本的 URI, 比如 https://api.xx.com/follows
• 标准 HTTP 方法, 如GET, POST, PUT, PATCH, DELETE
• 传输的数据媒体类型, 如JSON, XML

GET/users     //获取 user
GET/users/100  //查看具体的 user,这里是 100
POST/users  //新建一个 user
PUT/users   //更新 users
DELETE/users/100   //删除 user100

请求设计规范

• URI 使用名词, 尽量用复数, 如/users
• URI 使用嵌套表示关联关系, 如/users/100/repos/2
• 使用正确的 HTTP方法, 如 GET/POST/PUT/DELETE
• 不符合 CRUD 的情况: POST/action/子资源

响应设计规范

响应: 接口的返回值

• 查询
• 分页
• 字段过滤
• 状态码
• 错误处理(响应中加上错误处理)