Django+RestFramework API接口及接口文档并返回json数据操作-6ren

Django+RestFramework API接口及接口文档并返回json数据操作

转载作者：qq735679552 更新时间：2022-09-29 22:32:09

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章Django+RestFramework API接口及接口文档并返回json数据操作由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

系统：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数据.

以上这篇Django+RestFramework API接口及接口文档并返回json数据操作就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持我.

原文链接：https://blog.csdn.net/xingjidemimi/article/details/86694280 。

最后此篇关于Django+RestFramework API接口及接口文档并返回json数据操作的文章就讲到这里了,如果你想了解更多关于Django+RestFramework API接口及接口文档并返回json数据操作的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！。

文章推荐： Ubuntu 21.04 将重点提升主目录隐私安全性

文章推荐： Android提高之ListView实现自适应表格的方法

文章推荐： Android提高之TelephonyManager功能探秘

文章推荐： Android提高之蓝牙隐藏API探秘

django - 在 Django+Django REST 中创建具有外键关系的嵌套资源
我对 Python-Django 和 web 开发还很陌生，我被困在这个使用 POST 创建新资源的特殊问题上。我正在为 REST API 使用 Django REST 框架，我正在尝试创建一个新资
django - 如何下载使用 Django 存储上传的 Django 媒体文件？
我已经使用 Django-storages 成功地将 Word 文档存储到 S3。 class Document(TitleSlugDescriptionModel, TimeStampedModel
django - 如何在给定 Django 模型对象或查询集的情况下使用 Django 代理模型
我有 2 个关于模型代理的问题，如何从模型对象创建代理对象？如何从模型查询集创建代理查询集？例如，假设我们定义了: from django.contrib.auth.models import
django - 从 Django 测试访问 Django 测试服务器
我想编写一个直接执行 HTTP 请求的单元测试(而不是使用 django.test.client.Client)。如果您好奇为什么 - 那是因为我想测试我从 Django 应用程序公开的 Thrif
django - 如何开始构建 django 网站以及 django 如何构建页面？
我为我的个人网站启动了一个 django 项目来学习 django。到目前为止，我已经将我的开发环境设置为我需要的一切，并遵循 this很棒的教程来创建一些基本的数据结构和模板。现在我想开始使用我之前
django - Python/Django django-registration 添加一个额外的字段
我已经阅读了很多关于如何在使用 Django 注册时添加额外字段的信息，例如 here 、 here 和 here 。代码片段是: forms.py(来自注册应用程序) class Registrat
django - Django:如何从每个 View 写入当前用户名(django)
我正在编写小型社交应用程序。功能之一是在网站标题中写入用户名。因此，例如，如果我登录并且我的名字是Oleg(用户名)，那么我应该看到: Hello, Oleg | Click to edit prof
django - 如何将 django-reversion 添加到使用 django 和 django-rest 框架开发的应用程序中
我有一个使用 Django 和 Django Rest 框架开发的应用程序。我想将 django-reversion 功能添加到我的应用程序中。我已经尝试过http://django-reversi
django - 可以在没有 Django 表单的情况下呈现 Django 表单字段吗？
我有一个简单的 HTML 表单，我没有使用 Django 表单，但现在我想添加一个选择。选择最容易创建为 Django ChoiceField (与通过循环等手动创建选择相反)，但是，如果没有在 D
django - 字符串中的 Django 外键和不带字符串的 Django 外键有什么区别？
我不明白为什么人们以两种方式编写外键，这样做的目的是什么？它们是相同还是不同？我注意到有些人这样写: author = models.ForeignKey(Author, on_delete=mod
django - 使用 Django 评论获取 Django 中评论最多的帖子
我想在我的 Django 应用程序中获取评论最多的十个帖子，但我做不到，因为我想不出合适的方法。我目前正在使用 django 评论框架，并且我已经看到使用 aggregate or annotate
django - Django 管理中日期字段的自定义过滤器，Django 1.2
这对于 Django 1.2 仍然有效吗？ Custom Filter in Django Admin on Django 1.3 or below 我已经尝试过，但管理类中的 list_filter
django - 在 Django 中使用模板变量和 django-compressor
问题在于，当 django-compressor 编译为 .js 文件的 CoffeeScript 文件中引用 {{ STATIC_URL }} 时，它无法正确加载。在我的 django 模板中，我
django - 在事件应用程序上将数据从一个 django 模型移动到另一个(django+south)
我正在尝试将一些字段从一个 django 模型移动到一个新模型。假设我有一个书籍模型: class Book(models.Model): title = models.CharField(max
django - 使用 Django 评论获取 Django 中评论最多的帖子
我想在我的 Django 应用程序中获取评论最多的十个帖子，但我做不到，因为我想不出合适的方法。我目前正在使用 django 评论框架，并且我已经看到使用 aggregate or annotate
django - 比较 django 权限并使用 django 规则
目前我正在寻找在 Django 中实现访问控制。我已经阅读了有关内置权限的内容，但它并不关心每个对象的基础。例如，我想要“只有创建者可以删除自己的项目”之类的权限。所以我读到了 django-guar
django - 如何将 Django 模型的一个字段的值设置为等于其他 Django 模型的其他字段
嗨，我正在将我的 Django 模型的一个字段的值设置为其他模型的另一个字段的值。这个值应该是动态变化的。这是我的第一个模型 class MainModel(AbstractBaseUser, Pe
django - 来自模型的初始表单数据 - Django
我正在尝试为我的模型创建一个编辑表单。我没有使用模型表单，因为根据模型类型，用户可以使用不同的表单。 (例如，其中一个表单有 Tinymce 小部件，而另一个没有。) 有没有什么方法可以使用模型设置表
django - Django 模板中的搜索字段
Django 模板中的搜索字段如何在类似于此图像的 Django 模板中创建搜索字段 http://asciicasts.com/system/photos/1204/original/E354I0
django - Django 如何知道用户是谁？
根据 Django documentation ，如果 Django 安装激活了 AuthenticationMiddleware，HttpRequest 对象有一个“user”属性代表当前登录的用户

qq735679552

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城

Django+RestFramework API接口及接口文档并返回json数据操作