Django - - RESTful API介绍

阅读量：6966 次

发布时间：2019-06-27

本文共 3100 字，大约阅读时间需要 10 分钟。

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

2.8 错误处理

状态码是4xx时，应返回错误信息，error当做key。

{    error: "Invalid API key"}

2.9 返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范

GET /collection：返回资源对象的列表（数组）GET /collection/resource：返回单个资源对象POST /collection：返回新生成的资源对象PUT /collection/resource：返回完整的资源对象PATCH /collection/resource：返回完整的资源对象DELETE /collection/resource：返回一个空文档

2.10 Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

{"link": {  "rel":   "collection https://www.example.com/zoos",  "href":  "https://api.example.com/zoos",  "title": "List of zoos",  "type":  "application/vnd.yourformat+json"}}

参考文献：

3，基于Django实现RESTful API

3.1 路由

urlpatterns = [    url(r'^users', Users.as_view()),]

3.2 视图

from django.views import Viewfrom django.http import JsonResponse class Users(View):    def get(self, request, *args, **kwargs):        result = {            'code': 0,            'data': 'response data'        }        return JsonResponse(result, status=200)     def post(self, request, *args, **kwargs):        result = {            'code': 0,            'data': 'response data'        }        return JsonResponse(result, status=200)

4，基于Django REST Framework框架实现

4.1 路由

from django.conf.urls import url, includefrom web.views.s1_api import TestView urlpatterns = [    url(r'^test/', TestView.as_view()),]

4.2 视图

from rest_framework.views import APIViewfrom rest_framework.response import Response  class TestView(APIView):    def dispatch(self, request, *args, **kwargs):        """        请求到来之后，都要执行dispatch方法，dispatch方法根据请求方式不同触发 get/post/put等方法                 注意：APIView中的dispatch方法有好多好多的功能        """        return super().dispatch(request, *args, **kwargs)     def get(self, request, *args, **kwargs):        return Response('GET请求，响应内容')     def post(self, request, *args, **kwargs):        return Response('POST请求，响应内容')     def put(self, request, *args, **kwargs):        return Response('PUT请求，响应内容')