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

标签:Django,RestFramework,API,json
0
投稿

猜你喜欢

  • python创建堆的方法实例讲解

    2022-11-20 05:20:49
  • 举例讲解如何在Python编程中进行迭代和遍历

    2023-07-12 04:42:30
  • asp ajax注册验证之 防止用户名输入空格

    2011-03-11 11:17:00
  • django如何自定义manage.py管理命令

    2023-04-08 01:10:47
  • Python处理mat文件的三种方式小结

    2022-01-21 23:04:30
  • 有关Oracle数据库的备份情况

    2010-07-30 13:21:00
  • 微信小程序上传图片功能(附后端代码)

    2023-07-24 04:21:40
  • MASA Blazor入门详细教程

    2023-04-08 17:51:29
  • golang函数的返回值实现

    2024-04-23 09:47:52
  • 菜鸟课堂:MSSQL的安全设置问题解答

    2009-10-29 13:22:00
  • 一篇文章彻底搞懂Python切片操作

    2021-10-11 18:23:07
  • FLASH 全屏播放

    2008-07-19 11:36:00
  • python进阶教程之文本文件的读取和写入

    2023-08-03 03:27:47
  • Python和Excel的完美结合的常用操作案例汇总

    2021-12-30 05:15:37
  • MYSQL--自身字段约束级联删除

    2010-11-02 11:42:00
  • 海王小姐姐悄悄问我怎么在PC端登录多个微信

    2021-10-27 16:25:10
  • Vue2子组件绑定 v-model,实现父子组件通信方式

    2024-05-02 17:04:13
  • pandas分组聚合详解

    2023-06-28 15:50:25
  • Python编程实现线性回归和批量梯度下降法代码实例

    2021-10-13 07:33:27
  • SpringBoot+Mybatis-Plus实现mysql读写分离方案的示例代码

    2024-01-17 02:13:32
  • asp之家 网络编程 m.aspxhome.com