前台调用后台接口案例

最新推荐文章于 2021-08-31 17:07:27 发布

medigrat

最新推荐文章于 2021-08-31 17:07:27 发布

阅读量792

点赞数 1

分类专栏：小案例学drf 文章标签： python

本文链接：https://blog.csdn.net/medigrat/article/details/108806709

版权

小案例学drf 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

后台接口设计案例

该案例用来作为后台返回给前台的get单查与群查接口的设计案例，框架式的接口，旨在创造接口设计的意义。可以作为基础学习的模板案例，就好像可以用python写一句hello world，不过这个是后台返回数据给前台的"hello world"（捧哏：这里面是名词作为形容词用）。

准备工具

pycharm

postman

django3.1

djangorestframwork

步骤

前期的一些准备

1、创建项目

1-1、创建一个app名字为user的django项目

打开new project，然后就是创建一个django项目，

1-2、在指定目录下，创建一个项目名的drf_project20200925项目

1-3在根路径下的，与根文件夹同名的文件夹下的settings里面导入os模块

2、项目初始化

2-1、安装djangorestframework模块，

在项目终端的目录下敲pip install djangorestframework

2-2、注册在INSTALLED_APPS的列表中，注册这个rest_framework

注意这里面看是需要注册的，如果有报错，回看有没有注册这个user，与rest_framework，没有的话是都会有问题的。

3、项目开始设计

3-1、模型类、数据库、用户表设计

3-1-1、创建用户的模型类，设置图书的各个字段属性

在models.py文件中书写代码

class User(models.Model):
    name = models.CharField(max_length=64)
    address = models.CharField(max_length=64)

3-1-2、注册模型类，在admin中书写代码

from . import models
admin.site.register(models.User)

3-1-3、数据库迁移，在终端敲命令

python manage.py makemigrations
python manage.py migrate

3-1-4、创建超级用户，在终端敲命令

python manage.py createsuperuser

username:admin

Email address:（直接回车）

Password:Admin123

确认密码，再输入一次，如果常见的密码，会提示是否创建，选y回车，直接创建

3-1-5、用户表的创建

用超级用户的身份进入这个表，

在用户表中新增两个用户的名字与地址，

3-2、视图函数框架设计

3-2-1、用cbv方式搭建视图函数框架

3-2-3、定义get接口，定义post接口

from rest_framework.views import APIView
from rest_framework.response import Response

class UserAPIView(APIView):
    def get(self,request,*args,**kwargs):
        return Response('get ok')

    def post(self,request,*args,**kwargs):
        return Response('post ok')

3-3、路由框架设计

3-3-1、设置主路由分发

在主路由urls中配置，分发到子路由，user中的urls

include函数用于路由分发

from django.urls import path,include
urlpatterns = [
    path('admin/',admin.site.urls),
    path('user/',include('user.urls'))
]

3-3-2、配置子路由，映射视图函数

from django.conf.urls import url

from . import views
urlpatterns = [
    url(r'users/',views.UserAPIView.as_view())
]

4、测试

这个时候测试一下，用postman发送get与post请求，看能否得到一开始写好的信息。

5、更新设计

5-1更新子路由

更新子路由，设计get的单查与群查接口路由，用具体的^开始，$结束用来完全匹配路由

urlpatterns = [
    url(r'^users/$',views.UserAPIView.as_view()),
    url(r'^users/(?P<pk>\d+)$',views.UserAPIView.as_view()),
]

5-2更新视图函数

接口视图函数重新设计，设计与数据库表相连的视图函数

设计get接口的单查接口与群查接口

from rest_framework.views import APIView
from rest_framework.response import Response
from . import models

class UserAPIView(APIView):
    def _single_get(self,pk):
        obj1= models.User.objects.filter(pk=pk).values('name','address')
        return Response(list(obj1))

    def _multiple_get(self):
        obj2=models.User.objects.values('name','address')
        return Response(list(obj2))

    def get(self,request,*args,**kwargs):
        pk=kwargs.get('pk')
        if pk:
            return self._single_get(pk)
        else:
            return self._multiple_get()

    def post(self,request,*args,**kwargs):
        return Response('POST OK')

完整代码：

没有更改的文件不再这里体现，这里是有更改的文件的内容，文件内的注释有去掉大部分。有问题可以用这些代码排查错误文件位置。

settings.py

from pathlib import Path
import os

BASE_DIR = Path(__file__).resolve().parent.parent

#这个应该不可以复制的吧？ 
SECRET_KEY = '(rndlsy5a&e7$2aho7z-&fg^cdc$c86k+a9$g!dbx@a^a9x#02'


DEBUG = True

ALLOWED_HOSTS = []


INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'user.apps.UserConfig',
    'rest_framework'
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    # 'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
#这个应该不可以复制的吧？ 
ROOT_URLCONF = 'drf_project20200925_01.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')]
        ,
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]
#这个应该不可以复制的吧？ 
WSGI_APPLICATION = 'drf_project20200925_01.wsgi.application'


DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}


AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]


LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True


STATIC_URL = '/static/'

urls.py（主路由）

from django.contrib import admin
from django.conf.urls import url,include

#option1:
urlpatterns = [
    url('admin/', admin.site.urls),
    url('user/',include('user.urls')),
]

"""
#option2:
urlpatterns = [
    path('admin/', admin.site.urls),
    path('user/',include('user.urls'))，
]
"""

创建的app,user文件下的代码文件

admin.py

from django.contrib import admin
from . import models

admin.site.register(models.User)

models.py

from django.db import models

class User(models.Model):
    name = models.CharField(max_length=64)
    address = models.CharField(max_length=64)

urls.py（子路由）

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'users/$',views.UserAPIView.as_view()),
    url(r'^users/(?P<pk>\d+)$',views.UserAPIView.as_view()),
]

views.py

from rest_framework.views import APIView
from rest_framework.response import Response
from . import models

class UserAPIView(APIView):
    def _single_get(self,pk):
        obj1= models.User.objects.filter(pk=pk).values('name','address')
        return Response(list(obj1))

    def _multiple_get(self):
        obj2=models.User.objects.values('name','address')
        return Response(list(obj2))

    def get(self,request,*args,**kwargs):
        pk=kwargs.get('pk')
        if pk:
            return self._single_get(pk)
        else:
            return self._multiple_get()

    def post(self,request,*args,**kwargs):
        return Response('POST OK')

后记

这个叫做亲测有效代码！

还有就是数据库的配置，现在这个是自带的数据库，怎样改到mysql数据库？我会持续更新。

涂鸦问题

1、为什么这个启动的时候存的数据库是与我的另一个项目的20200919存的数据库是一致的，里面的表是一样的表？

2、django的后台管理超级用户为什么登录不进去？

重新启动之后就没有了这样的问题，（不知道怎么解决的，就解决了，）

3、还有admin中的site没有点出来register，为什么没有点出来这个方法？

4、views视图函数中，这边为什么用filter有效，用get没有效果呢？

5、教学视频中有这个first，实际并不需要啊，为什么视屏中老师要这个first呢？

views视图函数中需要注意的是什么呢？

values方法，filter方法，用list包裹这个queryset对象，还有单查传递的pk参数

出现问题，反馈学到的东西就是

1、用r’^user/$’,表示只能包含user/这个路由，

2、出现的是“单查”，查出所有的数据，为什么呢?

其实路由匹配的是群查，因为这边dollar符号非常重要，这是一个结束符号，没有这个符号的话，就代表是一段路由，就没有拿到pk,没有pk,就是群查。用$表示斜杠的分隔，拿到后一个斜杠后的数字。

3、因为django版本的原因，把其中的path函数改成过url函数，

主路由分发中，自己改动了，把原来的配置改动了，可以改，也可以不改。

提问你的问题

在user的app文件下创建urls的py文件，这个文件在配置主路由分发的时候需要导过来吗？为什么？

（不需要，因为。。。）

medigrat

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
前台调用后台接口案例

后台接口设计案例该案例用来作为后台返回给前台的get单查与群查接口的设计案例，框架式的接口，旨在创造接口设计的意义。可以作为基础学习的模板案例，就好像可以用python写一句hello world，不过这个是后台返回数据给前台的"hello world"（捧哏：这里面是名词作为形容词用）。准备工具pycharmpostmandjango3.1djangorestframwork步骤前期的一些准备1、创建项目 1-1、创建一个app名字为user的django项目打开new pro
复制链接

扫一扫