如何使用DRF自动生成接口文档?

2026-05-17 09:280阅读0评论SEO资源
  • 内容介绍
  • 文章标签
  • 相关推荐

本文共计753个文字,预计阅读时间需要4分钟。

自动生成接口文档(3星)前言+流程:后端人员写好接口,编写接口文档,供前端人员查看;前端人员根据接口文档开发;公司主流:后端,使用word、md编写,提交到git上;公司有接口平台,直接输出接口

自动生成接口文档(3星) 前言

流程: 后端人员写好接口,编写接口文档,给前端人员看,前端人员依照接口文档开发

公司里的主流:

  • 后端,使用world,md写,提到git上
  • 公司有接口平台,后端开发在接口平台录入(yapi,第三方),可以批量导入
  • 后端项目自动生成接口文档(不是特别美观或友好,有时候还需要配合上面两种)
    • -django的drf自动生成 coerapi,swagger:java,go,python
使用coreapi自动生成 安装依赖

REST framewrok生成接口文档需要coreapi库的支持。

pip3 install coreapi 设置接口文档访问路径

在总路由中添加接口文档路径。

文档路由对应的视图配置为rest_framework.documentation.include_docs_urls

参数title为接口文档网站的标题。

阅读全文

本文共计753个文字,预计阅读时间需要4分钟。

自动生成接口文档(3星)前言+流程:后端人员写好接口,编写接口文档,供前端人员查看;前端人员根据接口文档开发;公司主流:后端,使用word、md编写,提交到git上;公司有接口平台,直接输出接口

自动生成接口文档(3星) 前言

流程: 后端人员写好接口,编写接口文档,给前端人员看,前端人员依照接口文档开发

公司里的主流:

  • 后端,使用world,md写,提到git上
  • 公司有接口平台,后端开发在接口平台录入(yapi,第三方),可以批量导入
  • 后端项目自动生成接口文档(不是特别美观或友好,有时候还需要配合上面两种)
    • -django的drf自动生成 coerapi,swagger:java,go,python
使用coreapi自动生成 安装依赖

REST framewrok生成接口文档需要coreapi库的支持。

pip3 install coreapi 设置接口文档访问路径

在总路由中添加接口文档路径。

文档路由对应的视图配置为rest_framework.documentation.include_docs_urls

参数title为接口文档网站的标题。

阅读全文