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

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

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

在这里插入图片描述

测试apidoc是否安装成功

在这里插入图片描述
解决方法:
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/

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值