【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档
一、Swagger概述
1.引言
当接口开发完成,紧接着需要编写接口文档。传统的接口文档使用Word编写,or一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次接口有变更,需要手动修改接口文档。为了改善这种情况,推荐使用Swagger来管理接口文档,实现接口文档的自动更新。也推荐淘宝后端写的RAP2在线接口文档。
2.Swagger简介
Swagger:是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统源代码作为服务器以同样的速度来更新。当接口有变动时,对应的接口文档也会自动更新。
Swagger优势:
1)Swagger可生成一个具有互动性的API控制台,开发者可快速学习和尝试API
2)Swagger可生成客户端SDK代码,用于不同平台上(Java、Python...)的实现
3)Swagger文件可在许多不同的平台上从代码注释中自动生成
4)Swagger有一个强大的社区,里面有许多强悍的贡献者
二、Swagger安装和配置
参考官网:https://github.com/marcgibbons/django-rest-swagger
自动生成api文档(不管是函数视图还是类视图都能显示)
1.安装rest_framework_swagger库
pip install django-rest-swagger
2.在项目下的 urls.py 中加入如下:
from rest_framework_swagger.views import get_swagger_viewschema_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之基础知识大全关注公众号【刘旺學長】
【接口文档】Django restful framework中自动生成API文档相关推荐
- springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
- SpringBoot 自动生成API文档
SpringBoot 自动生成API文档 在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写, ...
- 超详细!使用swagger自动生成Api文档(swagger-ui)
介绍 swagger是什么? swagger-ui 使用swagger-ui 简单使用 swagger api注解 本文参考: 介绍 这里是一些介绍,如果想直接看如何使用,请直接跳过这部分.但如果有时 ...
- swagger php修改成中文,PHP使用swagger自动生成API文档
使用 swagger 自动生成 API 文档 使用 swagger 自动生成 API 文档,有需要的朋友可以参考下. 一.下载 swagger-ui 直接上传服务器 二.下载 swagger-php ...
- windows api中文文档_Web服务开发:Spring集成Swagger,3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法 在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
- 在django restful framework中设置django model的property
众所周知,在django的model中,可以某些字段设置@property和setter deleter getter,这样就可以在存入数据的时候进行一些操作,具体原理请参见廖雪峰大神的博客https ...
- swagger 修改dto注解_Web服务开发:Spring集成Swagger,3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法 在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
- 如何利用showdoc自动生成API文档
介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编 ...
- java apidoc案例_java 自动生成api 文档 :apidoc
官网:apidocjs 首先声明下,apidoc是基于注释来生成文档的,它不基于任何框架,而且支持大多数编程语言,适用于java项目.跟已有的项目框架没有任何关系 一.apidoc简介 apidoc通 ...
最新文章
- 开始学习吧,《算法》:动态连通性练习
- SAP常用T-Code
- signature=348a7ccbb9abe65fb90d6a0f44514435,Built-in self test for memory interconnect testing
- python课程典范选优_python学生选课系统
- 2020.10 小米赛第一场 A题
- C#调用三菱的MX Component控件与三菱PLC进行通讯
- vue生成静态html文件_Vue项目打包成一个HTML文件(包含CSS,JS)
- 计算机应用苹果笔记,使用感受 篇一:为什么我不推荐ipad+apple pencil记笔记(一反主流)...
- egg项目部署及PM2的使用
- View 5应用之五:iPad与Android携带虚拟桌面
- 2021年河南高考--各高校在河南录取分数线预测(本科一批——理科):
- 账号已被停用,请咨询系统管理员
- 上海韬源信息技术有限公司怎么样
- 景安服务器密码修改,[景安网络]提示页
- 新的开始——1月英语
- 基于Java Swing编写的运费计算系统
- 工具教程第九讲:以太坊区块浏览器使用
- ngular12版本引入ng-alain报错
- vue .env文件配置使用
- 计算机二级office应用,全国计算机二级MS OFFICE题库软件推出-全国二级MS考点