Django+RestFramework API接口及接口文档并返回json数据操作
作者:xingjidemimi 发布时间:2021-05-29 21:43:57
系统:ubuntu18.04 x64
GitHub:https://github.com/xingjidemimi/DjangoAPI.git
安装
pip install django==2.1.5
pip install djangorestframework # rest api
pip install coreapi pygments markdown # 自动化接口文档
API示例
创建django项目
django-admin startproject DjangoAPI
创建应用
cd DjangoAPI
python manage.py startapp apiApp
项目代码
修改settings.py,添加应用到配置中
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework', # 添加rest_framework应用
'apiApp', # 添加apiApp应用
]
执行数据库迁移
python manage.py migrate
创建管理员,会提示输入用户名:ubuntu,邮箱:ubuntu@ubuntu.ubuntu,密码:ubuntu123456
python manage.py createsuperuser
修改/api/models.py,创建数据库模型。
from django.db import models
class Test(models.Model):
name = models.CharField(u'姓名', max_length=100, default='no_name')
sex = models.CharField(u'性别', max_length=10, default='male')
age = models.CharField(u'年龄', max_length=3, default='0')
def __unicode__(self):
return '%d: %s' % (self.pk, self.name)
创建模型后执行:
python manage.py makemigrations # 生成数据库迁移文件
python manage.py migrate # 执行数据库迁移
修改/api/admin.py,写后台管理代码
from django.contrib import admin
from apiApp.models import Test
# Register your models here.
@admin.register(Test)
class BlogTypeAdmin(admin.ModelAdmin):
list_display = ('pk', 'name') # 在后台列表下显示的字段
运行项目
python manage.py runserver
出现如下内容表明成功:
System check identified no issues (0 silenced).
January 23, 2019 - 08:28:09
Django version 2.1.5, using settings 'DjangoAPI.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
浏览器输入:
http://127.0.0.1:8000/ # 出现django成功的界面
http://127.0.0.1:8000/admin # 进入管理后台
序列化模型类,在/api/下创建serializers.py,返回json数据
from rest_framework import serializers
from apiApp.models import Test
class TestSerializers(serializers.ModelSerializer):
class Meta:
model = Test # 指定的模型类
fields = ('pk', 'name', 'sex', 'age',) # 需要序列化的属性
修改/api/views.py,视图
from django.shortcuts import render
from rest_framework import viewsets
from apiApp.models import Test
from apiApp.serializers import TestSerializers
class TestViewSet(viewsets.ModelViewSet):
# 指定结果集并设置排序
queryset = Test.objects.all().order_by('-pk')
# 指定序列化的类
serializer_class = TestSerializers
修改/urls.py/,配置主路由
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('', include('apiApp.urls')), # 添加应用的路由地址
]
在/api/下创建urls.py,配置应用路由
from django.conf.urls import include
from django.urls import path
from rest_framework import routers
from apiApp import views
from rest_framework.documentation import include_docs_urls
API_TITLE = 'API Documents'
API_DESCRIPTION = 'API Information'
# 定义路由地址
route = routers.DefaultRouter()
# 注册新的路由地址
route.register(r'test', views.TestViewSet)
# 注册上一级的路由地址并添加
urlpatterns = [
path('', include(route.urls)),
# 接口文档路由
path(r'docs/', include_docs_urls(title=API_TITLE, description=API_DESCRIPTION, authentication_classes=[], permission_classes=[]))
]
运行项目
python manage.py runserver
打开浏览器输入:
http://127.0.0.1:8000 # api主页
点击主页提供的链接http://127.0.0.1:8000/test进入下一级目录
http://127.0.0.1:8000/docs进入接口文档
使用Postman测试工具测试api数据
进入ubuntusoftware应用商店,搜索postman进行安装
在postman中输入http://127.0.0.1:8000/api/student点击send,并返回json数据。
来源:https://blog.csdn.net/xingjidemimi/article/details/86694280
猜你喜欢
- <!DOCTYPE html PUBLIC "-//W3C//DTD X
- 一、 网页设计中的对比原则一件网页设计作品由许多元素构成,它们的重要性各不相同,其中一些元素的重要性要高于其它元素。一些相互关联,而另一些则
- 方法一:f = open("foo.txt") &
- 【原文地址】New "Orcas" Language Feature: Extension Methods【原文发表日期
- 这篇文章主要介绍了通过实例学习Python Excel操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要
- 定义总是很抽象。存储进程其实就是能完成一定操作的一组SQL语句,只不过这组语句是放在数据库中的(这里我们只谈SQL SERVER)。如果我们
- PIL vs PillowPIL: Python Imaging Library,是python的图像处理库。由于PIL不兼容setupto
- 一般情况下TextArea区输入的文字数量是没有限制的,但是我们可以通过javascript限制表单的文字字数。如下javascript代码
- 题目描述输入一行或多行字符串密码,验证每行密码是否符合规范,符合提示“OK”,否则“NG”。密码规范为:1.长度超过8位2.包括大小写字母.
- 使用 pdb 进行调试pdb 是 python 自带的一个包,为 python 程序提供了一种交互的源代码调试功能,主要特性包括设置断点、单
- 由于工作需要在一大堆日志里面提取相应的一些固定字符,如果单纯靠手工取提取,数据量大,劳心劳力,于是自然而然想到了用Python做一个对应的提
- SWFObject的使用是非常简单的,只需要包含 swfobject.js这个js文件,然后在DOM中插入一些简单的JS代码,就能嵌入Fla
- vi /etc/freetds/freetds.conf [global]# TDS protocol versiontds version
- 虽然说标题将的是首页的访问感受,但是同样适合于网站其它页面的用户体验设计,一个好的网站设计应当尽量做到首页和次页一视同仁。第一步(视觉设计)
- 1. 实验说明问题要求:针对静态单赋值(SSA)形式的函数中间代码输入,输出函数返回值的范围实现思路: 基本根据 2013年在CGO会议上提
- 昨天在做mergeCSS的时候遇到两个正则匹配的问题,也花了不少的时间,最后在CSS森林群的 CE 同学帮助下,才完成了这俩正则,特别记录下
- 最近项目中遇见 Jquery Ajax 缓存问题,load出来的页面状态有时正常,有时不对,记录一下,希望对大家有帮助使用jquery里lo
- 1,建立数据库文件cnbruce.mdb(不设计任何表)建立数据库的代码:<% Option Explicit&
- 在基于互联网的应用中,程序经常需要自动地发送电子邮件。如:一个网站的注册系统会在用户注册时发送一封邮件来确认注册;当用户忘记登陆密码的时候,
- 前言最近在学习python 爬虫方面的知识,网上有一博客专栏专门写爬虫方面的,看到用urllib请求有道翻译接口获取翻译结果。发现接口变化很