Django rest_framework实现RESTful API

1、什么是REST

　　面向资源是REST最明显的特征，资源是一种看待服务器的方式，将服务器看做是由不少离散的资源组成。每一个资源是服务器上一个可命名的抽象概念。由于资源是一个抽象的概念，因此它不单单能表明服务器文件系统中的一个文件、数据库中的一张表等等具体的东西，能够将资源设计的要多抽象有多抽象，只要想象力容许并且客户端应用开发者可以理解。

 

　　与面向对象设计相似，资源是以名词为核心来组织的，首先关注的是名词。一个资源能够由一个或多个URI来标识。URI既是资源的名称，也是资源在Web上的地址。对某个资源感兴趣的客户端应用，能够经过资源的URI与其进行交互。对于同一个资源的一组不一样的操做。资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。

 

　　REST要求，必须经过统一的接口来对资源执行各类操做。对于每一个资源只能执行一组有限的操做。（7个HTTP方法：GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS）

 

2、什么是RESTful API

符合REST架构设计的API。

 

这篇文章描述的很好，参考下加深理解 http://www.infoq.com/cn/articles/understanding-restful-style/

 

 

 

 

概念很少说了，具体经过下面的一个简单例子看看Django框架是怎么实现RESTful。

3、rest_framework模块

1.使用pip命令下载：pip3 install djangorestframework

 

2.新建一个Django项目

 

 

 

  3.建立一个apitest APP

cd d:\Tool # 切换到Tool目录

python manage.py startapp apitest   #建立apitest应用

 目录结构：

 

4.打开settings.py，增长一段配置：

INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'apitest', #添加apitest app 'rest_framework', #添加rest_framework ] #增长一段REST_FRAMEWORK配置 REST_FRAMEWORK = { # Use Django's standard `django.contrib.auth` permissions, # or allow read-only access for unauthenticated users. 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly' ], 'DEFAULT_RENDERER_CLASSES': ( 'rest_framework.renderers.JSONRenderer', ), 'DEFAULT_PARSER_CLASSES': ( 'rest_framework.parsers.JSONParser', ) }

 

5.在apitest目录下新建一个api.py，让咱们来写一些测试代码：

 

#coding=utf-8
from rest_framework import permissions from rest_framework.response import Response from rest_framework.decorators import api_view, permission_classes from django.views.decorators.csrf import csrf_exempt @csrf_exempt @api_view(http_method_names=['post'])                #只容许post
@permission_classes((permissions.AllowAny,)) def inventory(request): parameter = request.data id = parameter['data'] if id == 1: data = 'There are three dogs'
    elif id == 2: data = 'There are two dogs'
    else: data = 'nothing'

    return Response({'data':data})

 

 

 6.在urls.py添加刚刚建立的api路由：

urlpatterns = [ path('admin/', admin.site.urls),  path('food/', api.inventory), #添加api中inventory路由
]

 

 

上面配置好了以后本地调试下，输入命令：python manage.py runserver 8000

 

好了，服务器端代码已经写完。咱们能够经过约定好的名词food来获取或者更改资源。

 

而后写个小脚本测试下上面的接口：

import requests url= 'http://127.0.0.1:8000/food/' data = {'data':2} h=requests.post(url,json=data) print(h.text)

输出：

 

测试OK