# @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
    })
}
```