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

环境:

操作系统   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 用户登录* @apiName api测试* @apiGroup userApiStr* @apiVersion 1.0.0* @apiDescription 用于用户登录* @apiParam {String} userName 用户名* @apiParam {String} password 密码* @apiParamExample {json} 请求样例:*                ?userName=张三&password=11223344* @apiSuccess (200) {String} msg 信息* @apiSuccess (200) {String} code 0 代表无错误 1代表有错误* @apiSuccess (200) {String} user 用户信息* @apiSuccess (200) {String} userId 用户id* @apiSuccessExample {json} 返回样例:*                {"code":"0","msg":"登录成功","userId":"fe6386d550bd434b8cd994b58c3f8075"}*/

 

    3,生成apidoc文档,在当前注释文件目录下输入命令

apidoc -i /data/apidoc -o /data/apidoc
# apidoc    -i    注释文件所在目录路径     生成的apidoc文档所在目录路径

     

      完成后显示了生成的apidoc文件目录:

      

 打开  ”index.html“ 查看生成的接口文档

  到这里,apidoc就成功跑起来了

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/547979.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

频段表_5G频段范围之:频段3.3GHz-4.2GHz (n77,n78)

本文版权归“5G通信(tongxin5g)”和5G哥所有,未经授权,请勿转载比起以前的移动通信网络,5G探索的新频谱范围包括:3.3GHz-4.2GHz,4.4GHz-5.0GHz,24.25-29.5 GHz今天主要看频段3.3GHz-4.2GHz在3GPP中&#xf…

Signals Slots(Qt5)

>Signal-Slot的作用是对象间的通信; Signals-Slots机制是Qt的核心特性, 也可能是Qt和其他大多数框架提供的特性不同的部分; 介绍 >GUI编程中, 当我们改变了一个widget,经常希望另一个widget能被通知到; 通常我们希望各种对象间能互相通信. Example: 用户点击了CLOSE按钮,…

公开说说别人看不到_当听到别人在说自己坏话时,心里是什么感受?

人有优点也有缺点这世界上,没有人的性格可以做到十全十美。没有任何一个人从头到尾都是完美无缺的。一个人自从慢慢的长大后,在不断的社交活动中,就会慢慢的观察别人身上的优点或者缺点了。很奇怪,人的这种能力和本领好像是不需要…

CentOS 7 利用Docker搭建Showdoc文档管理系统

1,系统环境 a,操作系统 CentOS Linux release 7.6.1810 (Core) 64位 b,确保Docker环境已经安装,具体教程请看 CentOS 安装docker Docker部署Showdoc官方教程:https://www.showdoc.cc/help?page_id65610 2&…

制作安装媒体来部署额外域控制器

cmd:1. ntdsutil2. activate instance ntds3. ifm4. create [full|rodc] d:\InstallMedia5. quit6. quit转载于:https://blog.51cto.com/babylater/1182185

求最大公约数和最小公倍数

// 求两数的最大公约数 默认 a>bpublic static int func(int a,int b){return a % b0?b:func(b,a%b);}// 求两数的最小公倍数 默认 a>bpublic static int func2(int a,int b){int m a * b;return m / func(a,b);}

深度学习attention原理_深度学习Anchor Boxes原理与实战技术

深度学习Anchor Boxes原理与实战技术目标检测算法通常对输入图像中的大量区域进行采样,判断这些区域是否包含感兴趣的目标,并调整这些区域的边缘,以便更准确地预测目标的地面真实边界框。不同的模型可能使用不同的区域采样方法。在这里&#…

Linux利用nginx-gridfs搭建部署Nginx和MongoDB文件服务器,支持用户密码验证!

nginx-gridfs是一个nginx的扩展模块,用于支持直接访问MongoDB的GridFS文件系统上的文件并提供 HTTP 访问 1,安装nginx,下载好安装包nginx和nginx-gridfs,此次安装采用nginx1.12.2. mkdir -p /data/soft/nginx-mongodb/ # 创建…

安装Exchange 2010 时报错UserMailbox 必须强制使用 Database

安装Exchange 2010 时报错"UserMailbox 必须强制使用 Database"故障描述:在原有Exchange Server 2010 SP1的环境安装新的服务器上报"UserMailbox 必须强制使用 Database。 属性名称: Database"错,详细如下:错误:运行&quo…

三行代码生成验证码并转换成base64

使用 Hutool 工具类 import cn.hutool.captcha.CaptchaUtil; import cn.hutool.captcha.LineCaptcha; import cn.hutool.core.io.FileUtil; import cn.hutool.core.lang.Console; import sun.misc.BASE64Encoder;import java.io.File; import java.io.FileInputStream; import…

android 垂直的开关_安卓布局:如何让这两个按钮水平垂直居中

代码: 代码:android:id"id/linearLayout1" android:layout_width"wrap_content" android:layout_height"wrap_content" android:layout_alignParentBottom"true" android:layout_alignParentLeft"true&quo…

docker 创建容器报: Error response from daemon: C: drive is not shared.

报错 C:\Program Files\Docker\Docker\Resources\bin\docker.exe: Error response from daemon: C: drive is not shared. Please share it in Docker for Windows Settings. See C:\Program Files\Docker\Docker\Resources\bin\docker.exe run --help.这时候我们需要绑定盘符…

CentOS 7 搭建swagger Api文档管理系统

1,系统环境 a,操作系统 CentOS Linux release 7.6.1810 (Core) 64位 b,安装Node.js的npm工具环境: # Node 官网已经把 linux 下载版本更改为已编译好的版本了,我们可以直接下载解压后使用: wget http…

【Jectpack 基础】Jetpack Compose 文本居中的实现方法

在Jetpack Compose中,实现文本居中显示是一个常见的需求。本文将介绍一种简单而有效的方法,通过使用Compose的Modifier和Alignment属性来轻松实现文本的居中显示。 问题背景: 在开发中,我们经常需要将文本在其容器中水平和垂直方…

oracle数据库导入_oracle数据库导入数据

Oracle数据导入导出imp/exp功能:Oracle数据导入导出imp/exp就相当与oracle数据还原与备份。大多情况都可以用Oracle数据导入导出完成数据的备份和还原(不会造成数据的丢失)。Oracle有个好处,虽然你的电脑不是服务器,但是你装了oracle客户端&a…

宽带和流量是分开的吗_为什么现在的手机套餐与宽带越来越贵,只是因为建设5G吗?...

不知道你有没有这样一种感觉,手机的资费越来越高,并且宽带的资费也是开始上涨,随着5G时代的来到,我们现在的现在的的流量使用量也是越来越大,还记得2018的话费套餐最便宜的最低的只要8块钱,而29元能够办理包…

CentOS7 源码编译安装Redis shell脚本

1,系统环境 操作系统 CentOS Linux release 7.6.1810 (Core) 64位 2,执行以下命令完成安装 yum install -y gcc # 安装依赖包wget http://download.redis.io/releases/redis-5.0.5.tar.gz # 下载Redis安装包 tar -xzvf redis-5.0.5.tar.gzcd red…

SpringBoot 集成WebSocket

什么是WebSocket WebSocket 是一种网络通信协议,很多高级功能都需要它。 我们已经有了 HTTP 协议,为什么还需要另一个协议?它能带来什么好处? 因为 HTTP 协议有一个缺陷:通信只能由客户端发起。 如果我们想要服务器给…

大学电路题目怎么搜_长沙理工大学2020真题浅析

长沙理工大学2020年821电路,整体感觉难度还行,和邱版《电路》课后题的平均水平相当。整张卷子由9道填空题和七道大题目构成,填空一题5分,大题一题15分。先说说填空,1是一个等效电阻,当然上来先观察下平衡电…

maven识别包下的xml

<build><resources><resource><directory>src/main/java</directory><includes><include>**/*.xml</include></includes><!-- 不过滤 src/main/java 底下的xml文件 --><filtering>false</f…