apidoc生成接口文档

安装nodejs

安装nodejs,下载地址(https://nodejs.org/en/)
在这里插入图片描述

E:\Soft\Node\node_global>node -v
v12.18.2

E:\Soft\Node\node_global>npm -v
6.14.5

安装apidoc

npm install apidoc -g

安装之后进入node的node_global目录如下图说明安装完成
在这里插入图片描述

生成kotlin的在线接口文档

  1. 增加apidoc.json文件到项目根目录下:
{
  "name": "xxx接口文档",
  "version": "1.0.0",
  "description": "xxx接口文档", 
  "title": "xxx接口文档",
  "url" : "http://localhost:8080/api-ebike"
}
  1. 在apidoc所在的目录下执行生成命令
apidoc -f ".kt" -i E:\Data\KotlinWorkspace\apidoc-test -o E:\Data\KotlinWorkspace\apidoc-test\src\main\resources\static

需要注意的是把生成后的js和html都放到static目录下,这样就可以随着项目进行访问了。
在这里插入图片描述
效果图:
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值