apidoc操作

最新推荐文章于 2025-06-04 09:10:42 发布

原创最新推荐文章于 2025-06-04 09:10:42 发布 · 491 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#apidoc #api #doc #nodejs

git 专栏收录该内容

1 篇文章

订阅专栏

这篇博客介绍了如何使用apidoc来创建API文档。首先确保系统安装了Node.js，然后通过npm全局安装apidoc。接着初始化apidoc.json配置文件，并提供了示例注释来定义API组、参数和请求。示例中展示了用户登录API的详细说明，包括请求和响应示例，以及错误响应的处理。最后，执行apidoc命令生成文档。

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

apidoc操作

apidoc

首先要确认你的系统安装了nodejs
install apidoc

npm install -g apidoc

init apidoc.json

{
"name": "测试apidoc",   
"version": "1.0.0",                
"description": "接口测试",
"title": "test apidoc",
"url" : "http://localhost/test",
"sampleUrl" : "http://localhost/test"
}

init java ref:http://apidocjs.com/#params
/**
- @apiDefine CentraServerGroup Centra-Server
  *用户登录注册等
  */

/**
* @apiDefine UserParam
* @apiParam {Number} reqType .
* @apiParam {String} sign .
* @apiParam {String} password User password.
*/

/**
* @api {post} /user/signin User sign in
* @apiName signIn
* @apiGroup CentraServerGroup
* @apiUse UserParam
* @apiParamExample {json} Request-Example:
{
“osType”: 0,
“password”: “99”,
“userId”: “99@qq.com”
}

@apiSuccess {String} firstname Firstname of the User.
@apiSuccess {String} lastname Lastname of the User.
*
@apiSuccessExample Success-Response:
HTTP/1.1 200 OK
{
“firstname”: “John”,
“lastname”: “Doe”
}
*
@apiErrorExample Error-Response:
{
“info”: {
“message”: “Something went wrong with your Signin”
},
“code”: 0
}
*/