centos7.5 安装apidoc全过程实测

1.node安装

下载node安装包到指定目录

wget https://npm.taobao.org/mirrors/node/v11.0.0/node-v11.0.0.tar.gz(在用户目录下)

解压安装包

tar -xvf node-v11.0.0.tar.gz

进入目录并安装相关插件

    cd node-v11.0.0
    sudo yum install gcc gcc-c++

 进行默认配置并编译

    ./configure
    make

编译大概需要半小时左右~

之后就可以开始安装

sudo make install

之后验证安装

node -v

就会发现已经安装完成出现版本号

2.apidoc安装

sudo ln -s /usr/local/bin/node /usr/bin/node

sudo /usr/local/bin/npm install apidoc -g

安装完成

3.创建测试文件,apidoc.json文件和test.php文件(这步没测)

apidoc.json:

{

"name": "****",

"title": "****API",

"description":"****API接口文档",

"url" : "http://api.demo.com",

"version": "0.1.0"

}

test.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/bin/apidoc -i input_your_file/ -o output_your_file/

/usr/local/bin/apidoc -i /home/ntsyai/AI/Pneumothorax/Pneumothorax源码_centos7/Pneumothorax/service/ -o /home/ntsyai/AI/Pneumothorax/Pneumothorax源码_centos7/Pneumothorax/help/   (我用的可行)

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



参考:https://blog.csdn.net/in_christ/article/details/82107649

https://www.jianshu.com/p/b1578cab45b7

ps 打包

打开终端 source activate pneumothorax

接着先进入目标文件夹

python setup.py bdist_wheel

猜你喜欢

转载自blog.csdn.net/qq_36401512/article/details/84764292
0条评论
添加一条新回复