@mx-space/api-client 0.6.3 → 0.7.1

package/readme.md

@@ -1,84 +0,0 @@
-# MApi Client
-
-这是一个适用于 MServer v3 的 JS SDK，封装了常用接口请求方法以及返回类型的声明，以快速开发前端应用。
-
-## 如何使用
-
-此 SDK 设计之初不捆绑任何第三方网络请求库，同时也不使用任何请求方法。 使用适配器设计模式实现，你需要手动传入符合接口标准的适配器。
-
-此项目提供 `axios` 和 `umi-request` 两个适配器。
-
-以 `axios` 为例。
-
-```ts
-// esm format (spa recommend)
-import { axiosAdaptor } from '@mx-space/api-client/esm/adaptors/axios'
-// cjs format (ssr recommend)
-// import { axiosAdaptor } from '@mx-space/api-client/lib/adaptors/axios'
-import {
-  AggregateController,
-  CategoryController,
-  createClient,
-  NoteController,
-  PostController,
-  allControllers,
-  // ...
-} from '@mx-space/api-client'
-
-const endpoint = 'https://api.innei.dev/v2'
-const client = createClient(axiosAdaptor)(endpoint)
-
-// `default` is AxiosInstance
-// you can do anything else on this
-// interceptor or re-configure
-const $axios = axiosAdaptor.default
-// re-config (optional)
-$axios.defaults.timeout = 10000
-// set interceptors (optional)
-$axios.interceptors.request.use(
-  (config) => {
-    const token = getToken()
-    if (token) {
-      config.headers!['Authorization'] = 'bearer ' + getToken()
-    }
-
-    return config
-  },
-  (error) => {
-    if (__DEV__) {
-      console.log(error.message)
-    }
-
-    return Promise.reject(error)
-  },
-)
-
-// inject controller first.
-client.injectControllers([
-  PostController,
-  NoteController,
-  AggregateController,
-  CategoryController,
-])
-
-// or you can inject allControllers
-client.injectControllers(allControllers)
-
-// then you can request `post` `note` and `aggregate` controller
-
-client.post.post.getList(page, 10, { year }).then((data) => {
-  // do anything
-})
-```
-
-**为什么要手动注入控制器**
-
-按需加载，可以减少打包体积 (Tree Shake)
-
-**为什么不依赖请求库**
-
-可以防止项目中出现两个请求库，减少打包体积
-
-**如果不使用 axios，应该如何编写适配器**
-
-参考 `src/adaptors/axios.ts` 和 `src/adaptors/umi-request.ts`