apidoc写php接口文档

来源:互联网 发布:便宜的鼠标 知乎 编辑:程序博客网 时间:2024/06/01 09:45

1.apidoc需要node.js支持,需要安装node.js

2.通过npm安装apidoc 

npm install apidoc -g

3. 在项目目录里面创建apidoc相关信息,一般是放根目录下 本例是放根目录下docs文件夹中

4.在docs目录下,创建对应的具体接口信息 xxx.js,创建对应的模板文件apidoc.json(如果需要独立写footer.md,header.md,需要在创建这两个文件)

5.执行如下命令,生成文档到指定目录
apidoc -i docs/  -o web/docs -t docs/

根据根目录下docs/文件夹中的xxx.js文件生成文档接口具体信息,根据docs/apidoc.json生成文档的头部和尾部说明信息。

生成的内容在web/docs目录下。

6.每次修改文档信息,或者模板信息,需要执行5命令,重新生成文档。

具体文档和模板格式,参照官方文档即可:http://apidocjs.com/