Linux使用apidoc自动生成Restful web Api文档

短命女 2023-02-08 15:59 316阅读 0赞

## apidoc简介 ##

apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的所有风格的注释。

**支持的编程语言：**

1.  C\#, Go, Dart, Java, JavaScript, PHP(all DocStyle capable languages)
2.  CoffeeScript
3.  Erlang
4.  Ruby

## 安装node环境(已安装可忽略) ##

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

以Centos7.4 64位为例, 下载地址: [https://nodejs.org/dist/v12.18.3/node-v12.18.3-linux-x64.tar.xz][https_nodejs.org_dist_v12.18.3_node-v12.18.3-linux-x64.tar.xz]

wget https://nodejs.org/dist/v12.18.3/node-v12.18.3-linux-x64.tar.xz
    #或者下载到本地上传

#### 2.执行解xz、解压命令 ####

xz -d node-v12.18.3-linux-x64.tar.xz
    tar -xvf node-v12.18.3-linux-x64.tar

#### 3.创建软连接 ####

ln -s ~/node-v12.18.3-linux-x64/bin/node /usr/bin/node
    ln -s ~/node-v12.18.3-linux-x64/bin/npm /usr/bin/npm

`ln指令用于创建软连接（类似与Windows的快捷方式）必须给全路径，否则可能关联错误`

#### 4.测试 ####

node -v
    npm

## 安装apidoc ##

npm install apidoc -g

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhMTMxMjIzMTg4NjE_size_16_color_FFFFFF_t_70]

## 测试apidoc是否安装成功 ##

![在这里插入图片描述][20200724103645892.png]  
**解决方法：**  
cd到apidoc，將bin目录下的apidoc指令，软连接到/usr/local/bin

cd ~/node-v12.18.3-linux-x64/lib/node_modules/apidoc/bin/apidoc
    ln -s ~/node-v12.18.3-linux-x64/lib/node_modules/apidoc/bin/apidoc /usr/local/bin

最后到对应项目下运行apidoc命令即可生成文档

apidoc -i 接口路径 -o 生成文档路径

## apidoc具体使用 ##

参考官方文档[https://apidocjs.com/][https_apidocjs.com]

[https_nodejs.org_dist_v12.18.3_node-v12.18.3-linux-x64.tar.xz]: https://nodejs.org/dist/v12.18.3/node-v12.18.3-linux-x64.tar.xz
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhMTMxMjIzMTg4NjE_size_16_color_FFFFFF_t_70]: /images/20230208/b4779a1569ea4ede89ecd6d22cb5d0bd.png
[20200724103645892.png]: https://img-blog.csdnimg.cn/20200724103645892.png
[https_apidocjs.com]: https://apidocjs.com/