欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解Django rest_framework实现RESTful API

程序员文章站 2022-07-11 17:13:58
一、什么是rest 面向资源是rest最明显的特征,资源是一种看待服务器的方式,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个...

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

详解Django rest_framework实现RESTful API

2.新建一个django项目

详解Django rest_framework实现RESTful API

详解Django rest_framework实现RESTful API

3.创建一个apitest app

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

目录结构:

详解Django rest_framework实现RESTful API

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

详解Django rest_framework实现RESTful API

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

import requests

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

输出:

详解Django rest_framework实现RESTful API

测试ok

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。