简介
Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。
Node.js 使用了一个事件驱动、非阻塞式 I/O 的模型,使其轻量又高效。
Linux环境下安装NodeJs
1、去官网下载和自己系统匹配的文件:
英文网址:https://nodejs.org/en/download/
中文网址:http://nodejs.cn/download/
在Linux里通过 uname -a 命令查看到我的Linux系统位数是64位(备注:x86_64表示64位系统, i686 i386表示32位系统),如图
在官网上下载资源包:
在官网上点击该链接,即可下载,或是可以从我的百度资源上进行下载:
链接:https://pan.baidu.com/s/1dQzlwAbUiBR0b9vNL_v-mQ
提取码:bxy0
2、下载下来的tar文件上传到服务器并且解压,然后通过建立软连接变为全局;
1)上传服务器可以是自己任意路径,目前我的放置路径为 cd /mnt/nodejs/
2)解压上传(解压后的文件我这边将名字改为了nodejs,这个地方自己随意,只要在建立软连接的时候写正确就可以)
① tar -xvf node-v6.10.0-linux-x64.tar.xz
② mv node-v6.10.0-linux-x64 nodejs
③确认一下nodejs下bin目录是否有node 和npm文件,如果有执行软连接,如果没有重新下载执行上边步骤;
3)建立软连接,变为全局
①ln -s /mnt/nodejs/bin/npm /usr/local/bin/
②ln -s /mnt/nodejs/bin/node /usr/local/bin/
4)最后一步检验nodejs是否已变为全局
在Linux命令行node -v 命令会显示nodejs版本,如图所示为大功告成
安装aglio
介绍
aglio官网:
https://www.npmjs.com/package/aglio
进入官网
首先看张图中有两个圈起来的地方,底下的就是aglio的介绍,中文翻译过来,大致意思如下:
一个API蓝图,支持多种主题和输出,可以通过任何Web主机提供静态的HTML渲染器。API Blueprint是一种基于Markdown的文档格式,允许您以简单直接的方式编写API描述和文档。目前支持的是API Blueprint格式1A。
如上的意思就是说,aglio就是一个API Blueprint可以生产一个静态的HTML的API的东西,具有多种主题和风格可供我们选择,这对于我们开发完一个项目后需要写文档的人来说,意义可太大了,远的不说,起码别人再要项目API文档的时候,直接甩过去一个静态的HTML绝对比甩过去一个枯燥的DOC文档要逼格高多了。
我们知道了它的作用后就可以进行安装了,aglio有多种安装方式,我选择的是Linux,如果是在Windows环境安装也可以,但是必须安装Python,而如果在Linux里安装的话,虽说有些功能也需要安装Python才能使用,但是如果只是使用aglio来生成HTML页面的话就已经够用了。
在Linux安装了NodeJs后,我们可以使用官网上的命令来进行安装,如果按照该命令安装不成功的话,可以使用下面的命令:
npm install -g aglio --unsafe-perm=true --allow-root
在安装完成后,如何判断是否安装完成了呢?可以进入NodeJs的bin目录下进行查看:
如果已经出现了aglio的软连接,就表示已经安装成功了,就可以使用了。
使用aglio生成API
从上面的图中,我们可以看到有一个input.apib和output.html文件,那个input.apib文件就是要生成HTML文件的预编译文件,而output.html则是输出成功,可见,要想生成HTML文件,预生成文件的后缀必须是apib。
1、创建一个txt记事本,写入API内容,内容可以是纯粹的MarkDown,也可以是MarkDown和Html格式掺杂编写。
2、将写完的txt文件的后缀改完apib
3、将文件上传到NodeJs的bin目录下,就是上图所在目录
4、使用命令生成html文件。命令如下:
./aglio --theme-full-width -i input.apib -o output.html
5、将生成的output.html页面取出,打开页面
如此一来,一个网页API就生成好了,示例如下:
注意:aglio网站上有多种模式,可以自行生成自己喜欢的样式,也可以下载Docker镜像,使用命令来生成页面Api。
./aglio --theme-full-width -i input.apib -o output.html