一、doc文档

1.1 安装

需要安装以下几个包（如果有虚拟环境需要进入虚拟环境安装）

coreapi（必须）
Pygments（可选）
Markdown（可选）

1.2添加配置

3.10版本以上的DRF，需要添加配置信息，在setting.py文件的REST_FRAMEWORK中，添加如下代码：

REST_FRAMEWORK = {# 指定用于支持coreapi的Schema'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

在主路由中添加路由条目。修改url.py文件

from rest_framework.documentation import include_docs_urlsurlpatterns = [path('docs/', include_docs_urls(title='API接口文档', description='xxx描述'))
]

此时，访问http://127.0.0.1:8000/docs/就可以看到我们的接口文档了。

1.3给每个接口添加注释

在视图类中添加注释，格式为：方法名：注释。

class ProjectViewSet(viewsets.ModelViewSet):"""list:获取项目列表数据retrieve:获取项目详情数据..."""

二、swagger文档

1.1 安装

使用如下命令安装drf-yasg（如果有虚拟环境需要进入虚拟环境安装）
pip install drf-yasg

1.2 注册

在settings.py中注册子应用。

INSTALLED_APPS = [...'drf_yasg',
]

1.3 添加路由

在全局路由文件urls.py文件中添加如下代码：

from drf_yasg.views import get_schema_view
from drf_yasg import openapischema_view = get_schema_view(openapi.Info(title="Lemon API接口文档平台",    # 必传default_version='v1',   # 必传description="这是一个美轮美奂的接口文档",terms_of_service="http://api.keyou.site",contact=openapi.Contact(email="keyou100@qq.com"),license=openapi.License(name="BSD License"),),public=True,# permission_classes=(permissions.AllowAny,),   # 权限类
)urlpatterns = [...re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
]

此时，访问http://127.0.0.1:8000/swagger/就可以看到我们的swagger接口文档了。

Django-自动生成API文档相关推荐

【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
swagger php修改成中文,PHP使用swagger自动生成API文档
使用 swagger 自动生成 API 文档使用 swagger 自动生成 API 文档,有需要的朋友可以参考下. 一.下载 swagger-ui 直接上传服务器二.下载 swagger-php ...
SpringBoot 自动生成API文档
SpringBoot 自动生成API文档在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写, ...
超详细！使用swagger自动生成Api文档（swagger-ui）
介绍 swagger是什么? swagger-ui 使用swagger-ui 简单使用 swagger api注解本文参考: 介绍这里是一些介绍,如果想直接看如何使用,请直接跳过这部分.但如果有时 ...
windows api中文文档_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
swagger 修改dto注解_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
PHP使用swagger-php自动生成api文档（详细附上完整例子）
thinkphp5结合swagger自动生成接口文档整体介绍 swagger-php.swagger-ui.swagger-editor swagger-ui:主要就是放到tp项目public目录下 ...
如何利用showdoc自动生成API文档
介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编 ...
java apidoc案例_java 自动生成api 文档：apidoc
官网:apidocjs 首先声明下,apidoc是基于注释来生成文档的,它不基于任何框架,而且支持大多数编程语言,适用于java项目.跟已有的项目框架没有任何关系一.apidoc简介 apidoc通 ...

Django-自动生成API文档

自动生成API文档

一、doc文档

1.1 安装

1.2添加配置

1.3给每个接口添加注释

二、swagger文档

1.1 安装

1.2 注册

1.3 添加路由

Django-自动生成API文档相关推荐

最新文章

热门文章