简介

Yanhuang SDK 炎凰数据平台SDK

Yanhuang SDK是炎凰数据平台的重要组成部分，炎凰数据平台使用SDK和后端进行交互。用户在前端扩展时也能使用SDK对各种知识对象进行操作。

安装

炎凰SDK是以一个NPM package的形式发布，所以需要通过NPM或者yarn等包管理工具进行安装，用户可以执行以下命令安装：

yarn add --dev @yanhuang/sdk

Or

npm install --save-dev @yanhuang/sdk

基础使用

Service 是与炎凰数据集成的主要入口。用户可以通过Service来获取各种知识对象的操作接口。例如：

const { Service, Http } = require('@yanhuang/sdk');

const service = new Service({
    scheme: 'http',
    host: 'yh-test.yanhuangdata.com',
    port: 80,
    username: 'admin',
    password: 'changeme',
}, new Http());

const users = service.users;
users.fetch().then((usersFetched) => {
    // use usersFetched here
})


users.create({
    "username": "guest",
    "password": "xxxx",
    "firstName": "Jack",
    "lastName": "Sparrow",
    "email": "guest@xxx.com"
}).then((newUser) => {
    // use newUser here
});

Async & Await

async 和 await 是ES2016以后推出的新语法，能够时用户用同步代码的方式编写异步调用。而其对promise有很好的支持，在SDK的很多API中，我们都返回了Promise，用户可以很方便的使用await对这些api进行调用, 从而避免不必要的回调函数。 例如:

async function createUser(props) {
    const service = new Service({
        scheme: 'http',
        host: 'yh-test.yanhuangdata.com',
        port: 80,
        username: 'admin',
        password: 'changeme',
    }, new Http());

    const users = await service.users().fetch();
    const newUser = await users.create(props);
    // blablabla

}