javaweb项目使用apiDoc生成接口文档

javaweb项目使用apiDoc生成接口文档

一、安装node.js

1.下载链接:https://nodejs.org/zh-cn/
2.安装apiDoc,命令行:npm install apidoc -g

二、编写apidoc.json

  1. 编写apidoc.json
{
  "name": "api文档",
  "version": "0.1.0",
  "description": "api文档",
  "title": "APIDOC",
  "url" : "127.0.0.1/"
}

也可以加上

  "sampleUrl": "127.0.0.1/"

这样就会出现调用示例,但是我没用这个
如果用了出现问题参考(我也没看,目前没用到)
链接: 新版本的apidoc提交参数格式https://blog.csdn.net/licwzy/article/details/105265650.

2.文件命名apidoc.json,放进项目目录中

在这里插入图片描述

三、在代码中添加注释

/**
     * @api  createUser
     * @apiDescription  用户注册接口
     * @apiName 登录
     * @apiParam {String} workNo 工号
     * @apiParam {String} password 密码(加密之后)
     * @apiParam {String} userDept 部门id
     * @apiParam {String} name 用户名
     * @apiGroup 登录注册Login
     * @apiSuccess (返回参数) {int} status -2代表工号或重复
     */
    @RequestMapping("/createUser")
    public Result createUser(SysApproveUser approveUser){
    ....}

生成后预览如图
在这里插入图片描述

四、生成接口文档

在这里插入图片描述
我在项目目录同级,建立了一个doc的文件夹
在这里插入图片描述
之后使用cmd到这个目录

apidoc -i admin/ /doc

然后打开doc文件夹下的index.html即可

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值