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