Link Search Menu Expand Document

安装并配置SDK

  1. 安装
    1. React
    2. Vue 2.0
    3. Vue 3.0
  2. 配置SDK
    1. 初始化

安装

我们所有的 JavaScript SDK 都托管在 npmjs.com 上。

以下是安装 SDK, 并将其作为依赖项添加到您的项目中的指导:

Core SDK 托管地址 @XAuth/XAuth-core

React SDK 托管地址 @XAuth/XAuth-react

Vue SDK 托管地址 @XAuth/XAuth-vue

Vue 3.0 SDK 托管地址 @XAuth/XAuth-vue

React

需搭配@XAuth/sdk-core 使用

npm i --save @XAuth/sdk-core @XAuth/sdk-react

Vue 2.0

需搭配@XAuth/sdk-core 使用

npm i --save @XAuth/sdk-core @XAuth/sdk-vue-next

Vue 3.0

需搭配@XAuth/sdk-core 使用

npm i --save @XAuth/sdk-core @XAuth/sdk-vue

配置SDK

初始化

初始化时需要传入 issuerclientIdredirectUriscopes, 这些值可以从 XAuth 控制台得到 初始化 sdk 之后,

参数:

1.issuer:将租户名替换成实际的名字

2.redirectUri: 指向登录回调页面,登录完成后会将 code 和 state 或错误信息,作为 query 传递到这个 url 上。在@XAuth/vue, @XAuth/vue-next, @XAuth/react 中提供了<login-callback />组件,将该组件挂在到 redirectUri 上,后自动处理返回的信息

3.clientId: 在 XAuth 控制台的应用详情页面可得到

4.scopes: 可照如下填写

import XAuth from '@XAuth/sdk-core';
const XAuth = new XAuth({
  issuer: `https://${租户名}.xauth.cloud/oauth/v1`,
  clientId: `2YXXZ78611K0c8906MX6RJ8c0s84VcQB`,
  redirectUri: `http://localhost:3000/callback`,
  scopes: ['openid', 'profile', 'email'],
});