refactor: API类型声明优化调整

Former-commit-id: 0ae696c2e872fa90feba0c5df9a92391c02d3e0b

src/api/user/index.ts

@@ -0,0 +1,155 @@
+import request from '@/utils/request';
+import { AxiosPromise } from 'axios';
+import { UserForm, UserInfo, UserPageResult, UserQuery } from './types';
+
+/**
+ * 登录成功后获取用户信息（昵称、头像、权限集合和角色集合）
+ */
+export function getUserInfo(): AxiosPromise<UserInfo> {
+  return request({
+    url: '/api/v1/users/me',
+    method: 'get'
+  });
+}
+
+/**
+ * 获取用户分页列表
+ *
+ * @param queryParams
+ */
+export function listUserPages(
+  queryParams: UserQuery
+): AxiosPromise<UserPageResult> {
+  return request({
+    url: '/api/v1/users/pages',
+    method: 'get',
+    params: queryParams
+  });
+}
+
+/**
+ * 获取用户表单详情
+ *
+ * @param userId
+ */
+export function getUserForm(userId: number): AxiosPromise<UserForm> {
+  return request({
+    url: '/api/v1/users/' + userId + '/form',
+    method: 'get'
+  });
+}
+
+/**
+ * 添加用户
+ *
+ * @param data
+ */
+export function addUser(data: any) {
+  return request({
+    url: '/api/v1/users',
+    method: 'post',
+    data: data
+  });
+}
+
+/**
+ * 修改用户
+ *
+ * @param id
+ * @param data
+ */
+export function updateUser(id: number, data: UserForm) {
+  return request({
+    url: '/api/v1/users/' + id,
+    method: 'put',
+    data: data
+  });
+}
+
+/**
+ * 修改用户状态
+ *
+ * @param id
+ * @param status
+ */
+export function updateUserStatus(id: number, status: number) {
+  return request({
+    url: '/api/v1/users/' + id + '/status',
+    method: 'patch',
+    params: { status: status }
+  });
+}
+
+/**
+ * 修改用户密码
+ *
+ * @param id
+ * @param password
+ */
+export function updateUserPassword(id: number, password: string) {
+  return request({
+    url: '/api/v1/users/' + id + '/password',
+    method: 'patch',
+    params: { password: password }
+  });
+}
+
+/**
+ * 删除用户
+ *
+ * @param ids
+ */
+export function deleteUsers(ids: string) {
+  return request({
+    url: '/api/v1/users/' + ids,
+    method: 'delete'
+  });
+}
+
+/**
+ * 下载用户导入模板
+ *
+ * @returns
+ */
+export function downloadTemplate() {
+  return request({
+    url: '/api/v1/users/template',
+    method: 'get',
+    responseType: 'arraybuffer'
+  });
+}
+
+/**
+ * 导出用户
+ *
+ * @param queryParams
+ * @returns
+ */
+export function exportUser(queryParams: UserQuery) {
+  return request({
+    url: '/api/v1/users/_export',
+    method: 'get',
+    params: queryParams,
+    responseType: 'arraybuffer'
+  });
+}
+
+/**
+ * 导入用户
+ *
+ * @param file
+ */
+export function importUser(deptId: number, roleIds: string, file: File) {
+  const formData = new FormData();
+  formData.append('file', file);
+  formData.append('deptId', deptId.toString());
+  formData.append('roleIds', roleIds);
+  return request({
+    url: '/api/v1/users/_import',
+    method: 'post',
+    data: formData,
+    headers: {
+      'Content-Type': 'multipart/form-data'
+    }
+  });
+}

src/api/user/types.ts

@@ -0,0 +1,65 @@
+/**
+ * 登录用户信息
+ */
+export interface UserInfo {
+  nickname: string;
+  avatar: string;
+  roles: string[];
+  perms: string[];
+}
+
+/**
+ * 用户查询参数
+ */
+export interface UserQuery extends PageQuery {
+  keywords: string;
+  status: number;
+  deptId: number;
+}
+
+/**
+ * 用户分页列表项声明
+ */
+export interface UserType {
+  id: string;
+  username: string;
+  nickname: string;
+  mobile: string;
+  gender: number;
+  avatar: string;
+  email: string;
+  status: number;
+  deptName: string;
+  roleNames: string;
+  createTime: string;
+}
+
+/**
+ * 用户分页项类型声明
+ */
+export type UserPageResult = PageResult<UserType[]>;
+
+/**
+ * 用户表单类型声明
+ */
+export interface UserForm {
+  id: number | undefined;
+  deptId: number;
+  username: string;
+  nickname: string;
+  password: string;
+  mobile: string;
+  email: string;
+  gender: number;
+  status: number;
+  remark: string;
+  roleIds: number[];
+}
+
+/**
+ * 用户导入表单类型声明
+ */
+export interface UserImportData {
+  deptId: number;
+  roleIds: number[];
+}