mm_api 0.0.0-stage → 1.1.0

package/README.md

@@ -1,3 +1,3 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## API框架
+用于实现web api和mvc模式路由请求
+负责配置路由路径、访问权限、校验机制

package/com.json

@@ -0,0 +1,5 @@
+{
+    "name": "Api",
+    "title": "API管理器",
+    "state": 1
+}

package/config.tpl.json

@@ -0,0 +1,41 @@
+{
+	// 路由路径
+	"path": "{path || '/'}",
+	// 名称, 用于动态增删改API配置
+	"name": "{name || 'api'}",
+	// 标题, 用于开发文档显示
+	"title": "{title || '示例接口'}",
+	// 描述, 用于介绍该路由的作用
+	"description": "{description || '描述接口使用方法'}",
+	// 函数文件, 用于驱动脚本, 实现业务 
+	"main": "{main || './index.js'}",
+	// 请求方法, 选填 GET, POST, ALL。 ALL指同时支持GET/POST
+	"method": "ALL",
+	// 开放域, 如果域未开放, 则只有特定的协议头才能访问该API, 同时API文档不接见
+	"scope": true,
+	// 是否启用
+	"state": 1,
+	// 缓存时长, 单位: 分钟。使用缓存后, 二次访问API直接从缓存读取, 不重复执行业务脚本
+	"cache": 0,
+	// 是否客户端缓存, 使用客户端则不再访问服务器, 直接从浏览器中拿; 使用服务端缓存则会访问服务器   
+	"client_cache": false,
+	// SQL配置路径, 用于将请求参数拼接成SQL, 实现比较复杂的查询
+	"sql_path": "./sql.json",
+	// 参数配置路径, 用于校验API请求参数是否正确, 同时显示在API文档中 
+	"param_path": "./param.json",
+	/* 授权协议 */
+	"oauth": {
+		// 是否需要登录, true表示需要登录才能访问该接口
+		"sign_in": false,
+		// 会员权限级别, 如果小于该值, 则无法访问, 0为不限制
+		"vip": 0,
+		// 管理员权限级别, 如果小于该值, 则无法访问, 0为不限制
+		"gm": 0,
+		// 商户/第三方权限级别, 如果小于该值, 则无法访问, 0为不限制
+		"mc": 0,
+		// 用户组, 允许访问该接口的普通用户群体, 传ID数组，例如: [1,5]
+		"user_group": [],
+		// 管理组, 允许访问该接口的管理员群体, 传ID数组，例如: [1,5]
+		"user_admin": []
+	}
+}

package/index.js

@@ -0,0 +1,21 @@
+const Manager = require('./lib/manager');
+const Admin = require('mm_corejs').Admin;
+
+/**
+ * API管理器实例（Admin 工厂）
+ * 支持 os.js 调用：require('mm_api').admin.setServer(os) -> admin.get('os', config)
+ */
+let admin = new Admin();
+admin.setClass(Manager);
+
+module.exports = {
+  Drive: require('./lib/drive'),
+  Manager,
+  admin,
+  apiAdmin(scope, config) {
+    if (!scope) {
+      scope = 'os';
+    }
+    return admin.get(scope, { name: scope, ...config });
+  }
+};