详解Django rest_framework实现RESTful API

这篇文章主要介绍了详解Django rest_framework实现RESTful API,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

一、什么是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

  1. cd d:\Tool # 切换到Tool目录
  2. python manage.py startapp apitest #创建apitest应用

目录结构:

4.打开settings.py,增加一段配置:

  1. INSTALLED_APPS = [
  2. 'django.contrib.admin',
  3. 'django.contrib.auth',
  4. 'django.contrib.contenttypes',
  5. 'django.contrib.sessions',
  6. 'django.contrib.messages',
  7. 'django.contrib.staticfiles',
  8. 'apitest', #添加apitest app
  9. 'rest_framework', #添加rest_framework
  10. ]
  11.  
  12.  
  13. #增加一段REST_FRAMEWORK配置
  14. REST_FRAMEWORK = {
  15. # Use Django's standard `django.contrib.auth` permissions,
  16. # or allow read-only access for unauthenticated users.
  17. 'DEFAULT_PERMISSION_CLASSES': [
  18. 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
  19. ],
  20. 'DEFAULT_RENDERER_CLASSES': (
  21. 'rest_framework.renderers.JSONRenderer',
  22. ),
  23. 'DEFAULT_PARSER_CLASSES': (
  24. 'rest_framework.parsers.JSONParser',
  25. )
  26. }

5.在apitest目录下新建一个api.py,让我们来写一些测试代码:

  1. #coding=utf-8
  2. from rest_framework import permissions
  3. from rest_framework.response import Response
  4. from rest_framework.decorators import api_view, permission_classes
  5. from django.views.decorators.csrf import csrf_exempt
  6.  
  7. @csrf_exempt
  8. @api_view(http_method_names=['post']) #只允许post
  9. @permission_classes((permissions.AllowAny,))
  10. def inventory(request):
  11. parameter = request.data
  12. id = parameter['data']
  13. if id == 1:
  14. data = 'There are three dogs'
  15. elif id == 2:
  16. data = 'There are two dogs'
  17. else:
  18. data = 'nothing'
  19. return Response({'data':data})

6.在urls.py添加刚刚创建的api路由:

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

上面配置好了之后本地调试下,输入命令:python manage.py runserver 8000

好了,服务器端代码已经写完。我们可以通过约定好的名词food来获取或者更改资源。然后写个小脚本测试下上面的接口:

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

输出:

测试OK

posted @ 2019-08-26 16:46  技术颜良  阅读(652)  评论(0编辑  收藏  举报