快速根据注释生成接口文档网页工具——Apidoc的使用教程

本文档教程详细介绍了如何在CentOS 7环境下,通过安装Node.js的npm工具,然后使用Apidoc来生成接口文档。首先,安装npm环境,接着在Java程序中添加Apidoc注释,最后通过命令行生成apidoc文档,打开生成的HTML页面即可查看接口文档。
摘要由CSDN通过智能技术生成

环境:

操作系统   CentOS Linux release 7.6.1810 (Core)  64位

服务器环境   “腾讯云”服务器

 

1,安装Node.js的npm工具环境:

   如有不懂,请看我的博客:CentOS7 源码编译安装NodeJS 最新版本

2,npm环境搭好后,控制台运行命令:

npm install apidoc -g  

等待安装完成 

 

2,新建接口程序文件test.java 中添加apidoc文档注释

创建新目录

mkdir -p /data/apidoc/
cd /data/apidoc/

/data/apidoc目录新建文件test.java,内容如下:

/**
          * @apiDefine userApiStr 用户接口文档 
          */
        
        /**
         * @api {POST} /login 用户登录
         * @apiNam
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

青年夏日科技

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值