使用apiDoc进行python接口文档编写！

一、apidoc是什么？

apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的所有风格的注释。

二、环境配置

需要先 安装node.js

三、apiDoc的安装

四、使用：

五、使用案例：

最近团队对项目代码进行 review，制定了严格的前后端开发规范！为了更好，更高质量的代码交接，修改工作，api 文档必不可少！

1、apidoc 在python 接口中的使用示例：

2、在项目的根目录下增加 apidoc.json 文件：

六、生成apidoc文档

apidoc -i 代码所在路径 -o 生成文件的路径

最后会在 static 文件中生成 apidoc 文件夹，其中的index.html 即是生成的 html 文件。如下图所示：

打开index.html 文件就可以看到生成好的api 文档，如下图所示：

代码规范起来真的很重要！