好用的ApiDoc使用教程

最新推荐文章于 2025-03-19 10:05:00 发布

zmjheart

最新推荐文章于 2025-03-19 10:05:00 发布

阅读量869

点赞数

分类专栏： java 文章标签： java python vue nodejs js

本文链接：https://blog.youkuaiyun.com/zmjheart/article/details/105878628

版权

java 专栏收录该内容

4 篇文章

订阅专栏

本文档提供ApiDoc的详细使用教程，包括官网介绍、Node.js安装、ApiDoc安装步骤以及如何在Java接口上添加注释生成文档。最后，讲解如何将文档上传至Git并部署到服务器实现远程访问。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、官网

ApiDoc官网

二、安装教程

1.安装nodejs。去node.js官网下载安装一个nodejs

2.安装apidoc：命令行输入：npm install apidoc -g

三、使用教程

1.在你的项目的根目录下，创建名为apidoc.json的文件

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1"
}

2.例如在java的接口方法上加上如下要生成的内容的注释

/**
     * @api {POST} /lockers/client/shop/createShop createShop
     * @apiVersion 1.0.0
     * @apiGroup ShopController
     * @apiName createShop
     * @apiDescription 开店
     * @apiParam (请求参数) {String} userId
     * @apiParam (请求参数) {String} name
     * @apiParam (请求参数) {String} type
     * @apiParam (请求参数) {String} addr
     * @apiParam (请求参数) {String} startTime
     * @apiParam (请求参数) {String} endTime
     * @apiParam (请求参数) {String} phone
     * @apiParam (请求参数) {String} doorFace
     * @apiParam (请求参数) {String} busLicense
     * @apiParamExample 请求参数示例
     * doorFace=z&phone=Iu&busLicense=92uXhNgzt&name=9va&startTime=5&endTime=cANuFVVGT&type=Q&addr=NVK&userId=X1pWmU1t
     * @apiSuccess (响应结果) {String} msg
     * @apiSuccess (响应结果) {Number} code
     * @apiSuccess (响应结果) {Object} data
     * @apiSuccessExample 成功结果示例
     * {
     *     "msg": "成功",
     *     "code": 0,
     *     "data": null
     * }
     * @apiErrorExample 错误结果示例
     * {
     *     "msg": "店铺不存在",
     *     "code": 101,
     *     "data": null
     * }
     */

3.生成ApiDoc文档
在命令行输入如下命令

apidoc -i 项根目录绝对路径 -o 文档要输出的位置的绝对路径

4.大功告成是不是很简单下面看下效果
在这里插入图片描述
5.可以把此文档上传到git，然后使用git拉取到你的服务器上，然后代理这个项目即可实现远程访问。