文档

[[apiDoc]] api doc 的使用和部署 做 web 应用，总绕不开前后端数据接口的对接。如何才能写出一份简单、易于维护的 api 文档？ 这时候 api doc 就出现了。 apiDoc 是一个简单的 RESTful API 文档生成工具，它从代码注释中提取特定格式的内容，生成文档。 目前支持支持以下语言：C#、C/C++、D、Erlang、Go、Groovy、Java、JavaScript、Pascal/Delphi、 Perl、PHP、Python、Ruby、Rust、Scala 和 Swift。 以下的使用示例以 python 语言为主。 以下是官网APIDOC。 安装 npm install apidoc -g 设置apiDoc配置 在项目文件夹根目录创建文件 apidoc.json 文件。 里面的内容是对当前项目的描述。 其中 header 或者 footer 可以指向 md 文件，可以记录头信息和尾部信息。 { "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "title": "Custom apiDoc browser title", "url" : "https://api.github.com/v1"， "header": { "title": "Overview", "filename": "header.md" }, "footer": { "title": "Copyright", "filename": "footer.md" } } 创建 header.md 和 footer.md (非必须) 生成 api doc apidoc -i myapp/ -o apidoc/ -i 项目文件夹 -o apidoc文件夹 生成好了，就可以打开 apidoc/ 文件夹下的 index.html 就可以了。 ...