瀏覽代碼

feat: add @jy/api example

zhangyuhan 2 年之前
當前提交
ca044f447d
共有 4 個文件被更改,包括 136 次插入0 次删除
  1. 43 0
      data/api/README.md
  2. 2 0
      data/api/index.js
  3. 76 0
      data/api/modules/user.js
  4. 15 0
      data/api/package.json

+ 43 - 0
data/api/README.md

@@ -0,0 +1,43 @@
+# @jy/api
+> 按领域聚合API接口,对外提供 Promise 调用
+
+* 按照领域模型聚合API接口
+* 因为该包作为依赖静态编译,无需发布,无需更新 `version`
+
+
+## 安装
+
+```
+pnpm add @jy/api -F 项目名称
+```
+
+### 引用
+> 推荐用法为:在数据模型、Store中调用,提供对应Actions给组件使用,而不是直接在组件中调用API。
+```
+import { ajaxGetIdentityList, ajaxSwitchIdentity } from '@jy/api/modules/user'
+```
+
+## 维护
+
+### 新增/修改
+1. 对应添加 `/modules/领域.js`。
+2. 添加符合 JSDOC 格式的注释,见下方示例
+   * 描述`用途`、`请求方式`、`参数`
+
+```
+/**
+ * 根据Token切换用户身份
+ * @type {post}
+ * @param data.token - 选中身份对应的Token
+ */
+export function ajaxSwitchIdentity(data) {
+    return request({
+        url: '/publicapply/identity/switch',
+        method: 'post',
+        headers: {
+            'Content-Type': 'multipart/form-data'
+        },
+        data
+    })
+}
+```

+ 2 - 0
data/api/index.js

@@ -0,0 +1,2 @@
+import axios from 'axios'
+export default axios.create()

+ 76 - 0
data/api/modules/user.js

@@ -0,0 +1,76 @@
+import request from '../index'
+
+/**
+ * 获取用户大会员、超级订阅权限等信息
+ * @type {post}
+ */
+export function ajaxGetUserPower() {
+    return request({
+        url: '/bigmember/use/isAdd',
+        method: 'post'
+    })
+}
+
+/**
+ * 获取用户头像、昵称等信息
+ * @type {post}
+ */
+export function ajaxGetUserInfo() {
+    return request({
+        url: '/jypay/user/getSimpleData',
+        method: 'post'
+    })
+}
+
+/**
+ * 退出登录
+ * @type {post}
+ * @param data
+ */
+export function ajaxSetSignOut(data) {
+    return request({
+        url: '/front/signOut',
+        method: 'post',
+        data
+    })
+}
+
+/**
+ * 检查是否登录状态
+ * @type {post}
+ * @param data
+ */
+export function ajaxCheckUserLoginStatus(data) {
+    return request({
+        url: '/front/hasSign',
+        method: 'post',
+        data
+    })
+}
+
+/**
+ * 获取用户身份列表
+ * @type {post}
+ */
+export function ajaxGetIdentityList() {
+    return request({
+        url: '/publicapply/identity/list',
+        method: 'post'
+    })
+}
+
+/**
+ * 根据Token切换用户身份
+ * @type {post}
+ * @param data.token - 选中身份对应的Token
+ */
+export function ajaxSwitchIdentity(data) {
+    return request({
+        url: '/publicapply/identity/switch',
+        method: 'post',
+        headers: {
+            'Content-Type': 'multipart/form-data'
+        },
+        data
+    })
+}

+ 15 - 0
data/api/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@jy/api",
+  "version": "0.0.1",
+  "description": "按领域聚合API接口,对外提供 Promise 调用",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./modules/*": "./modules/*"
+  },
+  "keywords": [
+    "api",
+    "axios"
+  ]
+}