apidoc写php接口文档
来源:互联网 发布:便宜的鼠标 知乎 编辑:程序博客网 时间:2024/06/01 09:45
1.apidoc需要node.js支持,需要安装node.js
2.通过npm安装apidocnpm 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/阅读全文
0 0
- apidoc写php接口文档
- apidoc用于写http restful接口文档注意事项
- 用开源apidoc编写php接口文档,也可以编写其他语言apidoc安装使用
- 使用apidoc生成接口文档
- 编写接口文档apidoc用法
- apidoc接口文档自动生成工具
- 用apidoc 生成在线接口文档
- 利用apidoc维护api接口文档
- api 接口开发文档开发利器 --- apidoc
- 丢掉word,用apidoc来写文档
- 基于php开发的RESTful ApiDoc文档
- PHP 结合 apidoc生成文档树
- apidoc 文档
- 使用apidoc自动生成rest风格api接口文档
- spring-boot集成springfox(Swagger) (ApiDoc接口文档)
- apidoc 生成api文档
- apidoc生成resuful文档
- 如何写接口文档?
- tensorflow 学习笔记15 Batch Normalization实例
- ubuntu 终端常用命令(linux 常用命令)
- eclipse、环境变量、adb
- 前端的表现与数据分离(一)
- [BZOJ3083]遥远的国度-树链剖分-线段树
- apidoc写php接口文档
- demo2,网页换肤,总结
- C语言 类型转换
- CentOS7lamp环境搭建
- Maven坐标和资源库
- Unity-代码中动态设置Material参数
- 日记8/23
- linux下硬连接与软连接
- ConcurrentHashMap原理分析