一、什么是REST
面向资源是REST最明显的特征,资源是一种看待服务器的方式,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。
与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称,也是资源在Web上的地址。对某个资源感兴趣的客户端应用,可以通过资源的URI与其进行交互。对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念,资源是以名词为核心来组织的,首先关注的是名词。
REST要求,必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。(7个HTTP方法:GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS)
二、什么是RESTful
API符合REST架构设计的API。
概念不多说了,具体通过下面的一个简单例子看看Django框架是怎么实现RESTful。
三、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
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。
详解Django rest_framework实现RESTful API
- Author -
三只松鼠声明:登载此文出于传递更多信息之目的,并不意味着赞同其观点或证实其描述。
Reply on: @reply_date@
@reply_contents@