Django RESTful 设计风格

最新推荐文章于 2024-11-01 09:13:20 发布

聪明的大嘴花

最新推荐文章于 2024-11-01 09:13:20 发布

阅读量573

点赞数

分类专栏： django 文章标签： restful django http

本文链接：https://blog.youkuaiyun.com/weixin_46248273/article/details/122873716

版权

django 专栏收录该内容

15 篇文章

订阅专栏

REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，强调资源的定位和状态转换。通过URI标识资源，使用HTTP动词（GET, POST, PUT, PATCH, DELETE）来操作资源，实现客户端和服务器之间的交互。常见的状态码如200表示GET请求成功，201表示创建资源成功。设计时需遵循一定的原则，如使用合适的域名、版本路径等。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

全称：Representational State Transfer

资源
网络上的一个实体，或者说是网络上的一个具体信息，并且每个资源都有独一无二的URI与之相对应；获取资源-直接访问URI即可
表现层
如何去表现资源-即资源的表现形式；如 HTML、XML、JPG、json等
状态转化
访问一个URI即发生了一次客户端和服务器端的交互；此次交互将会涉及到数据和状态的变化
客户端需要通过某些方式触发具体的变化-HTTP method 如GET，POST，PUT，PATCH，DELETE等

特征

1. 每一个URI代表一种资源
2. 客户端和服务器端之间传递着资源的某种表现
3. 客户端通过HTTP的几个动作对资源进行操作-发生‘状态转化’

设计原则

1. 协议：http/https
2. 域名： 域名中体现出api字样，如 https://api.example.com or https://example.org/api/
3. 版本：https://api.example.com/v1/
4. 路径：路径中避免使用动词、资源用名词表示 如： https://api.example.com/v1/users
5. HTTP动词语义
		GET(SELECT)：从服务器取出资源（一项或多项）
		POST(CREATE)：在服务器新建一个资源
		PUT(UPDATE)：在服务器更新资源（哭护短提供改变后的完整资源）
		PATCH(UPDATE)：在服务器更新资源（客户端提供改变的属性）
		DELETE(DELETE)：从服务器删除资源

状态码

1. 用HTTP响应吗表达此次请求结果
	200 OK GET :服务器成功返回用户请求的数据
	201 CREATE POST/PUT/PATCH：用户新建或修改数据成功
2. 自定义内部code进行响应
	如：返回结构如下{'code':200,'data':{},'error':xxx}