Django restful framework生成API文档过程详解

 更新时间:2020年11月12日 10:56:07   作者:迎风而来  
这篇文章主要介绍了Django restful framework生成API文档过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

自动生成api文档(不管是函数视图还是类视图都能显示)

1.安装rest_framework_swagger库

pip install django-rest-swagger

2.在项目下的 urls.py 中加入如下:

from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='API文档')
urlpatterns += [
  path(r'docs/', schema_view),
]

3.在创建的django项目下的settings中加入如下:

INSTALLED_APPS = ['rest_framework_swagger']

REST_FRAMEWORK = {
  'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema'
}

4、生成的api文档界面如下:

5、DRF访问接口自带的界面如下:

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

相关文章

  • 详解Python程序与服务器连接的WSGI接口

    详解Python程序与服务器连接的WSGI接口

    这篇文章主要介绍了Python程序与服务器连接的WSGI接口,是Python网络编程学习当中的重要内容,需要的朋友可以参考下
    2015-04-04
  • PyQt5+QtChart实现绘制区域图

    PyQt5+QtChart实现绘制区域图

    QChart是一个QGraphicScene中可以显示的QGraphicsWidget。本文将利用QtChart实现区域图的绘制,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2022-12-12
  • Python报错KeyError: ‘missing_key‘的有效解决方法

    Python报错KeyError: ‘missing_key‘的有效解决方法

    在 Python 编程中,报错信息常常让开发者感到困扰,其中,“KeyError: ‘missing_key’”是一个较为常见的报错,它可能在各种数据处理和字典操作的场景中出现,本文将深入探讨这个报错的原因,并提供多种有效的解决方法,帮助开发者快速解决此类问题
    2024-10-10
  • 高考要来啦!用Python爬取历年高考数据并分析

    高考要来啦!用Python爬取历年高考数据并分析

    转眼间,高考的日子又要来临了,不知道高考学子们准备的怎么样了,今天这篇文章简单且随意地分析一下高考的一些数据,需要的朋友可以参考下
    2021-06-06
  • bat和python批量重命名文件的实现代码

    bat和python批量重命名文件的实现代码

    这篇文章主要介绍了bat和python批量重命名文件的实现代码,需要的朋友可以参考下
    2016-05-05
  • 详解Python Celery和RabbitMQ实战教程

    详解Python Celery和RabbitMQ实战教程

    这篇文章主要介绍了详解Python Celery和RabbitMQ实战教程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • Python3使用SMTP发送带附件邮件

    Python3使用SMTP发送带附件邮件

    这篇文章主要为大家详细介绍了Python3使用SMTP发送带附件邮件,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-06-06
  • python寻找list中最大值、最小值并返回其所在位置的方法

    python寻找list中最大值、最小值并返回其所在位置的方法

    今天小编就为大家分享一篇python寻找list中最大值、最小值并返回其所在位置的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-06-06
  • python爬虫selenium和phantomJs使用方法解析

    python爬虫selenium和phantomJs使用方法解析

    这篇文章主要介绍了python爬虫selenium和phantomJs使用方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • Python如何使用print()函数输出格式化字符串

    Python如何使用print()函数输出格式化字符串

    Python中内置的%操作符和format函数,都可以用于格式化字符串,下面这篇文章主要给大家介绍了关于Python如何使用print()函数输出格式化字符串的相关资料,需要的朋友可以参考下
    2021-08-08

最新评论