apidoc 的安装

1.先去官网下载已编译好的安装包

以Centos7.4 64位为例, 下载地址: https://nodejs.org/dist/v8.1.2/node-v8.1.2-linux-x64.tar.xz

wget https://nodejs.org/dist/v8.1.2/node-v8.1.2-linux-x64.tar.xz

执行解xz命令:

xz -d node-v8.1.2-linux-x64.tar.xz

再解压:

tar -xvf node-v8.1.2-linux-x64.tar

解压好的目录移动到指定位置:

mv node-v8.1.2-linux-x64 /usr/local/nodejs

做命令连接:

ln -s /usr/local/nodejs/bin/node /usr/local/bin
ln -s /usr/local/nodejs/bin/npm /usr/local/bin

测试版本号:

node -v

完成

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.创建测试文件，apidoc.json文件和test.php文件

apidoc.json:

{"name": "****","title": "****API","description":"****API接口文档","url" : "http://api.demo.com","version": "0.1.0"
}

test.php文件

<?php
/**** @api {get} /user/{id}* @apiDescription 获取用户信息接口描述
* @apiGroup User* @apiName getUserInfo* @apiParam {Number} id 用户ID* @apiVersion 0.1.0*** @apiExample {curl} 访问示例：
* curl -i http://api.demo.com/user/4711
** @apiSuccess {String} firstname Firstname of the User.* @apiSuccess {String} lastname  Lastname of the User.*/
function GetUser($id){}

4：生成对应的接口文档
采用下面的命令：

/usr/local/nodejs/bin/apidoc -i input_your_file/ -o output_your_file/

其中input_your_file放置的是事先按照apidoc格式编写好的js文件，output_your_file则指定了生成的html的位置。

例子如下：

注意：出现如下错误提示error: No files found，可能是某些文件导致出现的问题，需要自行确认查找那些文件影响了文档的生成

分类: 其他,linux

apidoc 的安装相关推荐

apidoc的安装与使用步骤
1.首先安装nodejs和npm 安装步骤:(1)下载:https://nodejs.org/en/ (2)直接对下载进行安装 (3)安装过程中,直接一直next,很简单 (4) 查看安装是否成功 ...
centos7.5 安装apidoc全过程实测
1.node安装下载node安装包到指定目录 wget https://npm.taobao.org/mirrors/node/v11.0.0/node-v11.0.0.tar.gz(在用户目录下) ...
apidoc学习（接口文档定义取代word）
apidoc的安装,参考:https://blog.csdn.net/qq_36386771/article/details/82149848 生产文档,需要先编写一个apidoc.json对接口文档 ...
[aspnetcore.apidoc]一款很不错的api文档生成工具
简单徐速一下为什么选用了aspnetcore.apidoc 而没有选用swagger 最初我们也有在试用swagger,但总是有些感觉,感觉有点不满意,就但从api文档角度来说,从前后端文档沟通角度来 ...
Python的apidoc操作
目录前言 apidoc的安装 Python文件定义接口信息 apidoc.json文件生成apidoc网页文件前言操作系统win10 时间2019年02月 Python版本:Python 3. ...
Apidoc使用说明
Apidoc 使用说明使用apidocJs快速生成在线文档 apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java.C.C#.PHP和JavaScript等.使用者仅 ...
Java—使用ApiDoc接口文档
Java-使用ApiDoc接口文档前言介绍: 之前写过使用Swagger编写Api接口文档 ,介绍了Java怎么使用Swagger做项目的Api接口文档.也百度过现在生成Api接口文档的工具,看到 ...
APIDOC使用避坑
在windows环境下安装nodejs,到nodejs官网下载适合自己机器的安装包之后,点击安装,一直下一步下一步,安装完成之后,打开cmd,在cmd中输入npm -v,如果有信息,那么代表nodej ...
python生成接口文档_使用apiDoc实现python接口文档编写
使用apiDoc实现python接口文档编写 apiDoc的安装 npm install apidoc -g 生成api的终端命令:apidoc -i 代码所在路径-o 生成文件的路径接口文档的编写 ...

apidoc 的安装

apidoc 的安装相关推荐

最新文章

热门文章