@ 连接edxm/admin- sdk @ 16. 13. 0
此生成器创建了 TypeScript/ JavaScript 客户端, 使用 轴。生成的节点模块可用于以下环境:
环境
- 节点.js
- 网络软件包
- 浏览器
语文级别
- ES5 - 您必须安装承诺/ A+ 库
- ES6 标准
模块系统
- 常见JS
- ES6模块系统
它既可用于TypeScript,也可用于JavaScript. 在 TypeScript 中,定义将通过 package.json. (中文(简体) )参考文献(中文(简体) )
大楼
要构建和编译用于 Javascript 的打字源 :
npm install
npm run build
出版
首先构建软件包然后运行 npm publish
消费
导航到您耗用工程的文件夹并运行以下命令之一 .
已出版:
npm install @connectedxm/[email protected] --save
未启用( 未建议):
npm install PATH_TO_GENERATED_PACKAGE --save
文档
所有URI都是相对 https://admin-api.connected.dev 互联网档案馆的存檔,存档日期2013-12-21
每个端点和每个模型参考页生成到 docs/
此软件包的目录。 它们是故意不联系到这里的 npm 和
GitHub 对照源寄存器解析相对链接, 其中
生成的 SDK 不承诺, 因此链接将全部 404 .
对于可浏览的API文档,参见已发布的OpenAPI参考.
授权文档
ApiKey Auth 密码
- 类型: API 密钥
- API 密钥参数名称: api 键
- 地点: HTTP 头
组织编号
- 类型: API 密钥
- API 密钥参数名称:组织
- 地点: HTTP 头