django使用apidoc生成rest_fromwork类型接口文档

django使用apidoc生成rest_fromwork类型接口文档

文档相关:

Git地址:https://github.com/apidoc/apidoc
项目地址:http://apidocjs.com/
样例项目:http://apidocjs.com/example_basic/

安装和使用:
a. 安装apidoc:在操作系统中运行 > npm install apidoc -g(-g 全局安装)
b. 加载相关文档到根项目下:
通过地址https://github.com/apidoc/apidoc下载项目,

在这里插入图片描述
将此文件里面的所有文件复制到django根项目里面。
c.使用:如果是将文件拷贝到项目的根目录下则执行 > apidoc -i “需要生成文档的文件路径” -o “文件生成存放路径”
eg:我的文件拷贝到项目的根目录下 ,需要生成的文件夹是api,存放路径为static里面的apidoc文件里面。
在操作系统中执行命令是apidoc -i api -o static/apidoc
在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值