Java——使用ApiDoc生成接口文档

---

一、ApiDoc是什么？

ApiDoc是一个接口文档生成工具，和SpringBoot的JApiDocs、swagger是一样的作用

---

二、使用步骤

1.安装

因为ApiDoc是基于node.js环境的，所以需要通过npm进行安装

npm install  -g  apidoc 

2.配置

在项目根目录下创建apidoc.json文件，进行如下配置：

{
  "name": "ScheduleAPIs",
  "version": "1.0.0",
  "description": "日程接口文档",
  "title": "ScheduleAPIs",
  "url" : "http://localhost:3000/"
}

name：接口文档名称
version: 接口文档版本
description： 接口文档描述
title: 文档打开时浏览器显示标题
url: 接口缺省访问地址。

---

三、简单使用

在接口上方加上如下注释：

/**
	 * @api 		{get} 	/wxw/test 	测试方法
	 * @apiGroup 	测试组
	 *
	 * @apiVersion	1.0.0
	 * @apiName 	test
	 *
	 * @apiDescription 	测试描述信息
	 *
	 * @apiParam 	(params)	{int} 		id  	id
	 * @apiParam 	(params) 	{String} 	name 	姓名
	 * @apiParam 	(params) 	{int} 		[age=0] 年龄
	 *
	 * @apiSuccess 	(resp) 		{String} 	a		字符串
	 *
	 * @apiSuccessExample 	{json}	成功
	 * {"a":"213213"}
	 */

生成的文档如下图所示：

version + group 用于标识每个接口
其他的对照图片能看出来