apidoc的安装和使用
来源:互联网 发布:淘宝在线代码编辑器 编辑:程序博客网 时间:2024/04/28 20:40
背景
基于代码中注释部生成接口文档,apidoc
安装和使用
1: 安装nodejs
下载最近版本:
wget http://nodejs.org/dist/v7.2.0/node-v7.2.0.tar.gz
tar -xvf node-v7.2.0.tar.gz
cd进入到该解压的文件夹中
./configure –prefix=/usr/local/nodejs
make && make install
期间如果提示权限不足,加上sudo即可。
2:安装apidoc
/usr/local/nodejs/bin/npm install apidoc -g
安装失败可能是由于权限不足,重新加上sudo进行安装:
sudo /usr/local/nodejs/bin/npm install apidoc -g
若提示“/usr/bin/env: node: No such file or directory”
ln -s /usr/local/nodejs/bin/node /usr/bin/node
3:生成对应的接口文档
采用下面的命令:
/usr/local/nodejs/bin/apidoc -i input/your_file/ -o output/your_file/
其中input/your_file放置的是事先按照apidoc格式编写好的js文件,output/your_file则指定了生成的html的位置。
参考:
https://github.com/apidoc/apidoc
http://apidocjs.com/
0 0
- apidoc的安装和使用
- apidoc的介绍和使用
- apidoc的介绍和使用
- api文档生成器apidoc的安装和使用
- APIDOC安装使用
- APIDOC安装使用
- apiDoc的使用
- 使用apidoc生成restful-api文档:安装nodejs+npm+apidoc
- apidoc windows下安装使用教程
- apidoc ----api文档生成工具的使用
- 开发API必备神器---ApiDoc的使用
- 用开源apidoc编写php接口文档,也可以编写其他语言apidoc安装使用
- apidoc 安装与使用示例生成 Api文档
- 安装配置apidoc
- laravel中使用apidoc
- ApiDoc学习使用
- laravel apidoc工具使用
- 【推荐】apidoc api文档生成工具的使用(mac)
- 腾讯云centos 7部署 dotnetcore+Angular2 实践
- wheelview中随机选号
- 蓝桥杯校园练习
- 冒泡排序(续)
- HDU-2544 最短路(Dijkstra算法求无向图最短路模板题)
- apidoc的安装和使用
- Error:java: Compilation failed: internal java compiler error
- 用到的软件
- 给函数传参的几种方式
- 文档编写
- Android中级:点9图
- XMind 6中缺失安装java环境改如何解决
- iOS开发之发送信息 邮件 打电话
- “使用多字节字符集”和“使用Unicode字符集”下的字符串的长度问题