欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

RESTful设计方法

程序员文章站 2022-06-27 21:06:10
为什么使用RESTfulRepresentational State Transfer 表现层状态转化( 资源定位及资源操作)表象层面说就是通过get,post,put,delete方式来实现前后台通信的一种轻量级,跨平台,跨语言架构设计风格的web服务1 增加商品# 增加商品POST /add-goods/前端发送了 post 请求请求路径为: /add-goods/2 删除商品# 删除商品POST /delete-goods/前端又发送了 po.....

为什么使用RESTful

Representational State Transfer  表现层状态转化( 资源定位及资源操作) 

表象层面说就是通过get,post,put,delete方式来实现前后台通信的一种轻量级,跨平台,跨语言架构设计风格的web服务

1 增加商品

# 增加商品
POST  /add-goods/

前端发送了 post 请求

请求路径为: /add-goods/

2 删除商品

# 删除商品
POST /delete-goods/

前端又发送了 post 请求

请求路径为: /delete-goods/

3 修改商品

# 修改商品
POST /update-goods/ 修改商品

前端还是发送的 post 请求

请求路径为: /update-goods/

4 查询商品

# 查询商品
GET /get-goods/ 查询商品

前端发送的 get 请求

请求路径为: /get-goods/

路径

只能有名词,不能有动词,而且所用的名词往往与数据库的表名对应.

GET   /products/4 :前端获取后端的单个产品(4号商品)
GET   /products :  前端获取后端的所有产品

POST  /products :  前端发给后端数据保存到后端
PUT   /products/4 :前端修改后端保存的数据
DELETE /products/4 : 前端删除后端保存的4号数据

名词能够使结构简洁.

API 中的名词应该使用复数.

举例来说,获取产品的 API 可以这样定义

获取单个产品:
http://127.0.0.1:8080/AppName/rest/products/1

获取所有产品: 
http://127.0.0.1:8080/AppName/rest/products

 

HTTP 动词

常用的HTTP动词有下面四个(括号里是对应的 SQL 命令).

- GET :    取出服务器资源 (一项或多项)
- POST :   往服务器新增一个资源.
- PUT :    修改服务器存储的资源 (客户端需提供修改所需的完整资源)
- DELETE :  删除服务器资源

下面是一些例子:

GET /zoos: 取出所有动物园
POST /zoos:新建一个动物园(上传文件)
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:取出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

本文地址:https://blog.csdn.net/qq_37703898/article/details/107378202

相关标签: 平时积累