10.springboot使用apidoc生成pai

来源：互联网发布：增加淘宝店铺流量编辑：程序博客网时间：2024/06/05 08:31

1.介绍

apidoc是基于注释生成api,不基于任何一种框架,主要是对代码没有侵入性。基于node.js环境所以需要先安装node.js

2.注释介绍

@api

@api {method} path [title]method：请求方法，path：请求路径 title(可选)：标题

@apiDescription

@apiDescription texttext说明

@apiError

@apiError [(group)] [{type}] field [description]（group）（可选）：参数将以这个名称分组，不设置的话，默认是Error 4xx {type}（可选）：返回值类型，例如：{Boolean}, {Number}, {String}, {Object}, {String[]} field：返回值字段名称 descriptionoptional（可选）：返回值字段说明

@apiGroup

@apiGroup namename：组名称，也是导航的标题

官方说明：http://apidocjs.com/#params

3.写一个注释

(1)项目主文件(pom.xml层)建立文件

apidoc.json

{  "name": "example",  "version": "0.1.0",  "description": "A basic apiDoc example"}

(2)写一个注释

/**     * @api {POST} /register 注册用户     * @apiGroup Users     * @apiVersion 0.0.1     * @apiDescription 用于注册用户     * @apiParam {String} account 用户账户名     * @apiParam {String} password 密码     * @apiParam {String} mobile 手机号     * @apiParam {int} vip = 0  是否注册Vip身份 0 普通用户 1 Vip用户     * @apiParam {String} [recommend] 邀请码     * @apiParamExample {json} 请求样例：     *                ?account=sodlinken&password=11223344&mobile=13739554137&vip=0&recommend=     * @apiSuccess (200) {String} msg 信息     * @apiSuccess (200) {int} code 0 代表无错误 1代表有错误     * @apiSuccessExample {json} 返回样例:     *                {"code":"0","msg":"注册成功"}     */

(3)生成文档

在工程外出目录建立一个输出文档的文件夹test

apidoc-test是工程名

apidoc -i apidoc-test/ -o test/

生成的index.html就是api文档

阅读全文

0 0