一、使用步骤
1、安装apidoc,需要安装node哦
npm install apidoc -g
2、写文档文件
文档文件是java的文件,格式如下,xx.java
/**
* @api {post} /taskjdb/createissue/ 获取用户信息接口
* @apiName GetUser
* @apiGroup 新版流程工单
*
* @apiParam {String} qnumber 问题编号
* @apiParam {String} qtitle 标题
* @apiParam {Number} issuetype 工单类型
*
* @apiSuccess {Boolean} issuc 返回结果标识
* @apiSuccess {String} msg 返回结果描述
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "issuc": True,
* "results": {}
* }
*
* @apiError UserNotFound The id of the User was not found.
*
* @apiErrorExample Error-Response:
* HTTP/1.1 404 Not Found
* {
* "error": "UserNotFound"
* }
*/
注意:根目录需要加apidoc.json配置文件
{
"name": "建造平台api文档",
"version": "1.0.0",
"description": "建造平台api文档",
"title": "建造平台api文档",
"url" : "http://127.0.0.1:8000"
}
配置说明如下:
name:项目名称
version:项目版本
description:项目介绍
title:浏览器显示的标题内容
url:endpoints的前缀,例如https://api.github.com/v1
sampleUrl:如果设置了,则在api文档中出现一个测试用的from表单
header
title:导航文字包含header.md文件
filename:markdown-file 文件名
footer
title:导航文字包含header.md文件
filename:markdown-file 文件名
order:用于配置输出 api-names/group-names 排序,在列表中的将按照列表中的顺序排序,不在列表中的名称将自动显示。
3、生成文档
使用命令,-i后面是文档文件的目录,-o后面是要生成文档存放的目录
apidoc -i DocApis/ -o static/docs/
4、展示效果
二、进阶使用
参考地址:https://blog.youkuaiyun.com/soslinken/article/details/50468896
https://blog.youkuaiyun.com/qq_32352777/article/details/102746237
官方地址:https://apidocjs.com/#install
@api使用
@api {method} path [title]
method:请求方法,post或者get
path:请求路径
title(可选):标题
朋友,你会了吗?