intellj idea apidoc模板

lein_wang

于 2018-10-09 21:06:27 发布

阅读量3.2k

点赞数

CC 4.0 BY-SA版权

分类专栏： PHP

本文链接：https://blog.csdn.net/lein_wang/article/details/82988754

PHP 专栏收录该内容

102 篇文章

订阅专栏

本文介绍如何在代码中使用特定注释格式来生成API文档，并通过apidoc工具将注释转换为清晰的文档。文章详细解释了设置LiveTemplate的方法，apidoc.json的配置，以及命令行的使用，帮助开发者高效地管理和维护API接口文档。

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

setting -> Editor -> Live Template -> add template group -> add live template:

/**
 * api url配置在apidoc.json里
 * sampleUrl配置在apidoc.json里
 * @api {post} /v1/方法名 方法名
 * @apiGroup 项目名
 * @apiName 方法名
 * @apiVersion 1.0.0
 *
 * @apiDescription 接口描述
 *
 * @apiParam {String} param1  参数说明
 *
 * @apiSuccess {Number} status    状态码，1：有数据/成功，-1：没数据/失败
 * @apiSuccess {String} msg   提示信息
 * @apiSuccess {Object} data    返回数据
 *
 * @apiSuccessExample {json} Success-Response:
 * {"status":1,"msg":"成功","data":[]}
 *
 * @apiErrorExample {json} Error-Response:
 * {"status":-1,"msg":"没有数据"}
 * 
 * @apiSampleRequest /方法名
 */
public function $NAME$($PARAMETERS$){
    $END$
}

apidoc.json :

{
  "name": "xxxx接口文档",
  "version": "1.0.0",
  "description": "xxxx接口文档",
  "title": "xxxx接口文档",
  "url" : "https://www.xxx.com/xxx/api",
  "sampleUrl" : "https://www.xxx.com/xxx/api/v1"
}