RESTful接口结构

协议:API与用户的通信协议,例如http或者https协议;
域名:应该尽量将API部署在专用域名之下。
http://rest.com/user/
路径:在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
https://rest.example.com/user

HTTP动词(REST资源操作)

对于资源的具体操作类型,由HTTP动词表示。
常用的HTTP动词有下面四个(括号里是对应的SQL命令)。
GET(SELECT):从服务器取出资源(一项或多项)。
POST(INSERT):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
DELETE(DELETE):从服务器删除资源。
还有三个不常用的HTTP动词。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
HEAD:获取资源的元数据。
OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

下面是一些例子。
GET /user:列出所有用户
POST /user:新建一个用户
GET /user/{id}:获取某个指定用户的信息
PUT /user/{id}:更新某个指定用户的信息(提供该用户的全部信息)
DELETE /zoos/{id}:删除某个用户

原来的方式
http://127.0.0.1/user/queryUser/{id} GET方法,根据用户id获取数据
http://127.0.0.1/user/updateUser POST方法,用户修改
http://127.0.0.1/user/saveUser POST方法,用户新增
http://127.0.0.1/user/deleteUser/{id} GET/POST方法,用户根据id删除

RESTful
http://127.0.0.1/user/{id} GET方法,根据用户id获取数据
http://127.0.0.1/user/ PUT方法,用户修改
http://127.0.0.1/user/ POST方法,用户新增
http://127.0.0.1/user/{id} DELETE方法,用户根据id删除

返回格式:json数据

RESTful接口结构

转载于:https://blog.51cto.com/huangyouyu/2057213