一 什么是REST
REST指Representational State Transfer,意思是表述性状态转移。其是一种架构规范,符合REST规范的Api设计称为RESTful Api。
何为表述性状态转移?
- 表述性:
指资源的表示形式,例如json、xml格式等。 - 状态转移:
描述服务器端资源的改变状态,利用通过增删改查导致的变化。 -
结论:
结合以上两点,表述性状态转移指的是客户端通过对服务器的增删改查而导致的表述性资源的状态转移。
二 接口设计规范
- 命名规范:
Url中使用名词复数,不能出现动词。 - 请求方法规范:
- GET:从服务器获取指定资源。
- POST:在服务器上创建一个新资源。
- PUT:更新服务器资源。
- DELETE:从服务器删除指定资源。
-
状态码:
三 例子
- 通过id获取用户的信息
GET /users/userId
反例:
GET /users/getUserById
- 通过id更新用户的信息
PUT /users/userId
反例:
POST /users/updateUserById