MDClub JavaScript SDK 文档

使用详解

通过 CDN 引入 JS 文件使用

CDN 的方式仅适用于浏览器环境。

在 HTML 中通过 <script> 标签引入 JS 文件：

<script
  src="https://unpkg.com/mdclub-sdk-js@1.0.4/dist/mdclub-sdk.min.js"
  integrity="sha256-h4XtKOU7LD8xH509/AbdZxu/4LiRvtxAUaRFCjj6xOk="
  crossorigin="anonymous"
></script>

然后就可以通过全局变量 mdclubSDK 访问 SDK 了。

你可以先通过 mdclubSDK.defaults 对 SDK 进行一些设置：

// 设置 api 地址（可选，默认为 {当前域名}/api）
mdclubSDK.defaults.apiPath = 'https://example.com/api';

// 若浏览器不支持 patch, put, delete 请求，则需要将该选项设为 true
mdclubSDK.defaults.methodOverride = true;

// 设置全局回调函数（可选）
mdclubSDK.defaults.beforeSend = function () {};
mdclubSDK.defaults.success = function (response) {};
mdclubSDK.defaults.error = function (errMsg) {};
mdclubSDK.defaults.complete = function () {};

然后可以如下调用 SDK 中的方法：

mdclubSDK.QuestionApi.getList({ question_id: 11 })
  .then((questions) => {
    console.log(questions);
  })
  .catch((errMsg) => {
    console.log(errMsg);
  });

在 ES6 模块化环境或小程序中使用

使用 npm 安装 SDK：

npm install mdclub-sdk-js --save

SDK 同时支持浏览器环境和小程序环境，你需要先根据使用环境设置适配器。

若在小程序中使用，需要设置成小程序适配器。支持微信小程序、支付宝小程序、钉钉小程序、百度小程序（注意：当前代码还未在小程序中进行过测试）：

import defaults from 'mdclub-sdk-js/es/defaults';
import MiniProgramAdapter from 'mdclub-sdk-js/es/adapter/MiniProgramAdapter';

defaults.adapter = new MiniProgramAdapter();

若在浏览器中使用，设置成浏览器适配器：

import defaults from 'mdclub-sdk-js/es/defaults';
import BrowserAdapter from 'mdclub-sdk-js/es/adapter/BrowserAdapter';

defaults.adapter = new BrowserAdapter();

若你的项目中已经通过 npm 安装了 jQuery、axios 之类的库，则可以设置对应的适配器，SDK 将直接使用对应的库提供的 ajax 方法。下面是所有支持的适配器：

import defaults from 'mdclub-sdk-js/es/defaults';
import AxiosAdapter from 'mdclub-sdk-js/es/adapter/AxiosAdapter';

defaults.adapter = new AxiosAdapter();

import defaults from 'mdclub-sdk-js/es/defaults';
import BrowserAdapter from 'mdclub-sdk-js/es/adapter/BrowserAdapter';

defaults.adapter = new BrowserAdapter();

import defaults from 'mdclub-sdk-js/es/defaults';
import FetchAdapter from 'mdclub-sdk-js/es/adapter/FetchAdapter';

defaults.adapter = new FetchAdapter();

import defaults from 'mdclub-sdk-js/es/defaults';
import JQueryAdapter from 'mdclub-sdk-js/es/adapter/JQueryAdapter';

defaults.adapter = new JQueryAdapter();

import defaults from 'mdclub-sdk-js/es/defaults';
import MiniProgramAdapter from 'mdclub-sdk-js/es/adapter/MiniProgramAdapter';

defaults.adapter = new MiniProgramAdapter();

还可以选择对 SDK 进行一些全局设置，这些设置都是可选的。

import defaults from 'mdclub-sdk-js/es/defaults';

// 设置 api 地址，默认为 {当前域名}/api
defaults.apiPath = 'https://example.com/api';

// 若浏览器不支持 patch, put, delete 方法，则需要将该选项设为 true
defaults.methodOverride = true;

// 设置全局回调函数
defaults.beforeSend = () => {};
defaults.success = () => {};
defaults.error = () => {};
defaults.complete = () => {};

然后就可以调用 SDK 方法了：

import QuestionApi from 'mdclub-sdk-js/es/QuestionApi';

QuestionApi.getList({ question_id: 11 })
  .then((questions) => {
    console.log(questions);
  })
  .catch((errMsg) => {
    console.log(errMsg);
  });

参数与返回值

所有 SDK 方法，都只有一个参数，参数类型为对象。

所有方法的返回值都是 Promise。若请求成功，即响应的 code 为 0，则 Promise 的状态为 reslove；若响应的 code 大于 0，则 Promise 的状态为 reject。

下面的例子是调用 QuestionApi.getList 方法的示例：

// 导入 QuestionApi 分组下的所有方法
import QuestionApi from 'mdclub-sdk-js/es/QuestionApi';

// 调用方法，参数为一个对象
QuestionApi.getList({ question_id: 11 })
  .then((questions) => {
    // 响应的 code 为 0
    console.log(questions);
  })
  .catch((err) => {
    // 响应的 code 大于 0，错误代码所表示的含义见下面的“错误代码”部分
    console.log(err);
  });

用户登录

用户登录功能需调用 TokenApi.login 方法，在该方法调用成功后，SDK 会自动保存登录 token，在通过 SDK 调用其他方法时，会自动携带上 token。

因此，使用 SDK 时，你无需考虑如何保存登录状态。

错误代码

方法列表

身份验证

系统设置

用户

话题

提问

回答

文章

评论

举报

通知

图形验证码

邮件

图片

数据统计