安装配置apidoc文档生成工具

1:首先需要安装node.js

网址: https://nodejs.org/en/#download

2:输入命令进行安装

npm install apidoc -g

3:生成doc目录

例子:apidoc -i ~/Tools/apidoc-master/ -o doc/
格式: apidoc -i myapp/ -o apidoc/ -t mytemplate/
-o --output :输出的文件夹路径
-i --input:输入的文件夹路径
-t --template :使用模板输出文件。您可以创建和使用自己的模版

4:配置apidoc.json文件

{
"name": "example",
"version": "0.1.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1"
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,032评论 19 139
  • Ubuntu的发音 Ubuntu,源于非洲祖鲁人和科萨人的语言,发作 oo-boon-too 的音。了解发音是有意...
    萤火虫de梦阅读 99,647评论 9 468
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,618评论 0 17
  • 1、环境准备 安装node.js:https://segmentfault.com/a/1190000006694...
    Uzero阅读 5,419评论 2 0
  • static 修饰局部变量让局部变量只初始化一次局部变量在程序中只有一份内存并不会改变局部变量的作用域,仅仅是改变...
    zhazha阅读 5,849评论 11 25