From a765aab3ff26b36d95e31133cfdb339046d8e71b Mon Sep 17 00:00:00 2001 From: azw Date: Sat, 2 Sep 2023 20:26:03 +0800 Subject: [PATCH] 1 --- doc/admin/README.php | 11 +++++++++++ doc/admin/User.js | 34 ++++++++++++++++++++++++++++++++++ doc/admin/common.js | 15 +++++++++++++++ doc/admin/env.json | 3 +++ 4 files changed, 63 insertions(+) create mode 100644 doc/admin/README.php create mode 100644 doc/admin/User.js create mode 100644 doc/admin/common.js create mode 100644 doc/admin/env.json diff --git a/doc/admin/README.php b/doc/admin/README.php new file mode 100644 index 00000000..c036f2a3 --- /dev/null +++ b/doc/admin/README.php @@ -0,0 +1,11 @@ +/** + * @api {GET} AA开发指南 AA开发指南 + * @apiPermission none + * @apiGroup AA开发指南 + * @apiVersion 0.0.1 + * @apiSuccessExample {json} Success-Response: + * 所有的协议都可能携带award和property_chg,award用来显示获得的东西,propery_chg用来更新本地数据 + * + * + * + */ diff --git a/doc/admin/User.js b/doc/admin/User.js new file mode 100644 index 00000000..c59cc04b --- /dev/null +++ b/doc/admin/User.js @@ -0,0 +1,34 @@ +const common = require('./common'); + +exports.User = class { + + const apis = [ + { + 'method': 'GET', + 'name': 'login', + 'desc': '用户登录', + 'group': 'User', + 'url': 'api/v1/user/login', + 'params': [ + ['account', '', '账号'], + ['passwd', '', '密码'] + ], + 'response': [ + new common.RspHead(), + ] + }, + { + 'method': 'GET', + 'name': 'info', + 'desc': '用户登录', + 'group': 'User', + 'url': 'api/v1/user/info/:user_id', + 'params': [ + ], + 'response': [ + new common.RspHead(), + ] + }, + ]; + +}; diff --git a/doc/admin/common.js b/doc/admin/common.js new file mode 100644 index 00000000..b509ae82 --- /dev/null +++ b/doc/admin/common.js @@ -0,0 +1,15 @@ +exports.ReqHead = class { + + const fields = [ + ]; + +}; + +exports.RspHead = class { + + const fields = [ + ['errcode', 0, '错误码/0 成功;1 失败'], + ['errmsg', '', '错误描述'], + ]; + +}; diff --git a/doc/admin/env.json b/doc/admin/env.json new file mode 100644 index 00000000..f1b47aa3 --- /dev/null +++ b/doc/admin/env.json @@ -0,0 +1,3 @@ +{ + "name": "game2006admin" +}