Rest Framework-CSDN博客

本文详细讲解了RESTful架构原则，包括API设计规范、HTTPS安全传输、状态码管理，并通过Django实例展示了如何实现路由和视图函数。

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

RESTful规范

一什么是RESTful

REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
所有的数据，不管是通过网络获取的还是操作(增删改查)的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构(ROA：Resource Oriented Architecture)

二 RESTful API设计

api接口

-规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介。公司开发中一般有接口文档来规范api接口--可以手动写(公司有平台，录到平台里，)--自动生成(coreapi，swagger)

restful规范

1，为保证数据的安全可靠，一般使用https进行数据的传输。

2，域名一般会有api标识，https://api.example.com 尽量将API部署在专用域名。

3，请求地址中带版本号，或者将版本号放在请求头中。-https://127.0.0.0:8080/api/v1(版本号)/

4，请求地址中任何东西都是资源，均使用名词代替(尽量不使用动词)--https://api.example.com/v1/books/ --https://api.example.com/v1/get_all_books(不符合规范)

5，通过请求方式区分不同操作

-get获取 -post新增数据 -put/patch：patch是局部更新，put是全部(基本上更新都用put) -delete：删除

6，在请求路径中带过滤

https://api.example.com/v1/?name='金'&order=asc
https://api.example.com/v1/name?sortby=name&order=asc

7，返回的数据中带状态码

-http请求的状态码(2xx,3xx,4xx,5xx)

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [*] 表示用户得到授权(与401错误相对)，但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得(比如用户请求JSON格式，但是只有XML格式)。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

状态码

-返回的json格式中的状态码(标志当次请求成功或失败)

8，返回的数据中带错误信息--错误处理，应返回错误信息，error当做key

9，对不同操作，返回数据符合如下规范：

GET /books：返回资源对象的列表(数组)[{},{},{}]
GET /books/1：返回单个资源对象 {}
POST /books：返回新生成的资源对象 {新增的书}
PUT /books/1：返回完整的资源对象 {返回修改后的}
PATCH /books/1：返回完整的资源对象 {返回修改后的}
DELETE /books/1：返回一个空文档
{status:100,msg:查询成功,data:null}

10，返回的结果中应该带有链接

三基于Django实现

路由系统：

urlpatterns = [
    url(r'^users/$', views.Users.as_view()),
    url(r'^users2/$', views.user2),

]

视图函数：

import json

def  user2(request):
    if request.method=='GET':
        dic = {'status':200,'name': 'lqz2', 'age': 18}
        return HttpResponse(json.dumps(dic))
    elif request.method=='POST':
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)

class Users(View):
    def get(self, request):
        dic = {'status':200,'name': 'lqz', 'age': 18}
        return HttpResponse(json.dumps(dic))

    def post(self, request):
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)