tongtong/vue3-element-admin
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: API类型声明优化调整

Browse Source 
Former-commit-id: 0ae696c2e872fa90feba0c5df9a92391c02d3e0b
This commit is contained in:
haoxr
2022-11-08 22:53:42 +08:00
parent 94b93f02a1
commit b39ff7b1f6
38 changed files with 468 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/api/auth.ts → src/api/auth/index.ts
View File

@@ -1,11 +1,13 @@
import request from '@/utils/request';
import { AxiosPromise } from 'axios';
import { LoginFormData } from '@/types/api/user';
import { LoginForm, VerifyCode } from './types';
/**
* 登录
*
* @param data {LoginForm}
* @returns
*/
export function login(data: LoginFormData): AxiosPromise {
export function loginApi(data: LoginForm): AxiosPromise<string> {
return request({
url: '/api/v1/auth/login',
method: 'post',
@@ -19,9 +21,19 @@ export function login(data: LoginFormData): AxiosPromise {
/**
* 注销
*/
export function logout() {
export function logoutApi() {
return request({
url: '/api/v1/auth/logout',
method: 'delete'
});
}
/**
* 获取图片验证码
*/
export function getCaptcha(): AxiosPromise<VerifyCode> {
return request({
url: '/captcha?t=' + new Date().getTime().toString(),
method: 'get'
});
}

32
src/api/auth/types.ts Normal file
View File

@@ -0,0 +1,32 @@
/**
* 登录表单类型声明
*/
export interface LoginForm {
username: string;
password: string;
grant_type: string;
/**
* 验证码Code
*/
//verifyCode: string;
/**
* 验证码Code服务端缓存key(UUID)
*/
// verifyCodeKey: string;
}
/**
* 登录响应类型声明
*/
export interface LoginResult {
access_token: string;
token_type: string;
}
/**
* 验证码类型声明
*/
export interface VerifyCode {
verifyCodeImg: string;
verifyCodeKey: string;
}

15
src/api/dept.ts → src/api/dept/index.ts
View File

@@ -1,16 +1,13 @@
import { DeptFormData, DeptItem, DeptQueryParam } from '@/types/api/dept';
import { Option } from '@/types/common';
import request from '@/utils/request';
import { AxiosPromise } from 'axios';
import { DeptForm, DeptQuery, Dept } from './types';
/**
* 部门树形表格
*
* @param queryParams
*/
export function listDepartments(
queryParams?: DeptQueryParam
): AxiosPromise<DeptItem[]> {
export function listDepartments(queryParams?: DeptQuery): AxiosPromise<Dept[]> {
return request({
url: '/api/v1/dept',
method: 'get',
@@ -21,7 +18,7 @@ export function listDepartments(
/**
* 部门下拉列表
*/
export function listDeptOptions(): AxiosPromise<Option[]> {
export function listDeptOptions(): AxiosPromise<OptionType[]> {
return request({
url: '/api/v1/dept/options',
method: 'get'
@@ -33,7 +30,7 @@ export function listDeptOptions(): AxiosPromise<Option[]> {
*
* @param id
*/
export function getDeptForm(id: string): AxiosPromise<DeptFormData> {
export function getDeptForm(id: string): AxiosPromise<DeptForm> {
return request({
url: '/api/v1/dept/' + id + '/form',
method: 'get'
@@ -45,7 +42,7 @@ export function getDeptForm(id: string): AxiosPromise<DeptFormData> {
*
* @param data
*/
export function addDept(data: DeptFormData) {
export function addDept(data: DeptForm) {
return request({
url: '/api/v1/dept',
method: 'post',
@@ -59,7 +56,7 @@ export function addDept(data: DeptFormData) {
* @param id
* @param data
*/
export function updateDept(id: string, data: DeptFormData) {
export function updateDept(id: string, data: DeptForm) {
return request({
url: '/api/v1/dept/' + id,
method: 'put',

34
src/api/dept/types.ts Normal file
View File

@@ -0,0 +1,34 @@
/**
* 部门查询参数
*/
export interface DeptQuery {
keywords: string | undefined;
status: number | undefined;
}
/**
* 部门类型
*/
export interface Dept {
id: string;
name: string;
parentId: string;
treePath: string;
sort: number;
status: number;
leader?: string;
mobile?: string;
email?: string;
children: Dept[];
}
/**
* 部门表单类型
*/
export interface DeptForm {
id?: string;
parentId: string;
name: string;
sort: number;
status: number;
}

35
src/api/dict.ts → src/api/dict/index.ts
View File

@@ -1,14 +1,13 @@
import { Option } from '@/types/common';
import {
DictTypeFormData,
DictItemFormData,
DictItemPageResult,
DictItemQueryParam,
DictPageResult,
DictQueryParam
} from '@/types/api/dict';
import request from '@/utils/request';
import { AxiosPromise } from 'axios';
import {
DictQuery,
DictPageResult,
DictTypeForm,
DictItemQuery,
DictItemPageResult,
DictItemForm
} from './types';
/**
* 获取字典类型分页列表
@@ -16,7 +15,7 @@ import { AxiosPromise } from 'axios';
* @param queryParams
*/
export function listDictTypePages(
queryParams: DictQueryParam
queryParams: DictQuery
): AxiosPromise<DictPageResult> {
return request({
url: '/api/v1/dict/types/pages',
@@ -30,7 +29,7 @@ export function listDictTypePages(
*
* @param id
*/
export function getDictTypeForm(id: number): AxiosPromise<DictTypeFormData> {
export function getDictTypeForm(id: number): AxiosPromise<DictTypeForm> {
return request({
url: '/api/v1/dict/types/' + id + '/form',
method: 'get'
@@ -42,7 +41,7 @@ export function getDictTypeForm(id: number): AxiosPromise<DictTypeFormData> {
*
* @param data
*/
export function addDictType(data: DictTypeFormData) {
export function addDictType(data: DictTypeForm) {
return request({
url: '/api/v1/dict/types',
method: 'post',
@@ -56,7 +55,7 @@ export function addDictType(data: DictTypeFormData) {
* @param id
* @param data
*/
export function updateDictType(id: number, data: DictTypeFormData) {
export function updateDictType(id: number, data: DictTypeForm) {
return request({
url: '/api/v1/dict/types/' + id,
method: 'put',
@@ -81,7 +80,7 @@ export function deleteDictTypes(ids: string) {
*/
export function listDictItemsByTypeCode(
typeCode: string
): AxiosPromise<Option[]> {
): AxiosPromise<OptionType[]> {
return request({
url: '/api/v1/dict/types/' + typeCode + '/items',
method: 'get'
@@ -92,7 +91,7 @@ export function listDictItemsByTypeCode(
* 获取字典项分页列表
*/
export function listDictItemPages(
queryParams: DictItemQueryParam
queryParams: DictItemQuery
): AxiosPromise<DictItemPageResult> {
return request({
url: '/api/v1/dict/items/pages',
@@ -106,7 +105,7 @@ export function listDictItemPages(
*
* @param id
*/
export function getDictItemData(id: number): AxiosPromise<DictItemFormData> {
export function getDictItemData(id: number): AxiosPromise<DictItemForm> {
return request({
url: '/api/v1/dict/items/' + id + '/form',
method: 'get'
@@ -118,7 +117,7 @@ export function getDictItemData(id: number): AxiosPromise<DictItemFormData> {
*
* @param data
*/
export function saveDictItem(data: DictItemFormData) {
export function saveDictItem(data: DictItemForm) {
return request({
url: '/api/v1/dict/items',
method: 'post',
@@ -132,7 +131,7 @@ export function saveDictItem(data: DictItemFormData) {
* @param id
* @param data
*/
export function updateDictItem(id: number, data: DictItemFormData) {
export function updateDictItem(id: number, data: DictItemForm) {
return request({
url: '/api/v1/dict/items/' + id,
method: 'put',

84
src/api/dict/types.ts Normal file
View File

@@ -0,0 +1,84 @@
/**
* 字典查询参数
*/
export interface DictQuery extends PageQuery {
/**
* 字典名称
*/
name?: string;
}
/**
* 字典类型
*/
export interface Dict {
id: number;
code: string;
name: string;
status: number;
remark: string;
}
/**
* 字典分页项类型声明
*/
export type DictPageResult = PageResult<Dict[]>;
/**
* 字典表单类型声明
*/
export interface DictTypeForm {
id: number | undefined;
name: string;
code: string;
status: number;
remark: string;
}
/**
* 字典项查询参数类型声明
*/
export interface DictItemQuery extends PageQuery {
/**
* 字典项名称
*/
name?: string;
/**
* 字典类型编码
*/
typeCode?: string;
}
/**
* 字典数据项类型
*/
export interface DictItem {
id: number;
name: string;
value: string;
typeCode: string;
sort: number;
status: number;
defaulted: number;
remark?: string;
}
/**
* 字典分页项类型声明
*/
export type DictItemPageResult = PageResult<DictItem[]>;
/**
* 字典表单类型声明
*/
export interface DictItemForm {
id?: number;
typeCode?: string;
typeName?: string;
name: string;
code: string;
value: string;
status: number;
sort: number;
remark: string;
}

20
src/api/menu.ts → src/api/menu/index.ts
View File

@@ -1,12 +1,6 @@
import {
MenuFormData,
MenuItem,
MenuQueryParam,
Resource
} from '@/types/api/menu';
import { Option } from '@/types/common';
import request from '@/utils/request';
import { AxiosPromise } from 'axios';
import { MenuQuery, Menu, Resource, MenuForm } from './types';
/**
* 获取路由列表
@@ -23,9 +17,7 @@ export function listRoutes() {
*
* @param queryParams
*/
export function listMenus(
queryParams: MenuQueryParam
): AxiosPromise<MenuItem[]> {
export function listMenus(queryParams: MenuQuery): AxiosPromise<Menu[]> {
return request({
url: '/api/v1/menus',
method: 'get',
@@ -36,7 +28,7 @@ export function listMenus(
/**
* 获取菜单下拉树形列表
*/
export function listMenuOptions(): AxiosPromise<Option[]> {
export function listMenuOptions(): AxiosPromise<OptionType[]> {
return request({
url: '/api/v1/menus/options',
method: 'get'
@@ -57,7 +49,7 @@ export function listResources(): AxiosPromise<Resource[]> {
* 获取菜单详情
* @param id
*/
export function getMenuDetail(id: string): AxiosPromise<MenuFormData> {
export function getMenuDetail(id: string): AxiosPromise<MenuForm> {
return request({
url: '/api/v1/menus/' + id,
method: 'get'
@@ -69,7 +61,7 @@ export function getMenuDetail(id: string): AxiosPromise<MenuFormData> {
*
* @param data
*/
export function addMenu(data: MenuFormData) {
export function addMenu(data: MenuForm) {
return request({
url: '/api/v1/menus',
method: 'post',
@@ -83,7 +75,7 @@ export function addMenu(data: MenuFormData) {
* @param id
* @param data
*/
export function updateMenu(id: string, data: MenuFormData) {
export function updateMenu(id: string, data: MenuForm) {
return request({
url: '/api/v1/menus/' + id,
method: 'put',

105
src/api/menu/types.ts Normal file
View File

@@ -0,0 +1,105 @@
/**
* 菜单查询参数类型声明
*/
export interface MenuQuery {
keywords?: string;
}
/**
* 菜单分页列表项声明
*/
export interface Menu {
id?: number;
parentId: number;
type?: string | 'CATEGORY' | 'MENU' | 'EXTLINK';
createTime: string;
updateTime: string;
name: string;
icon: string;
component: string;
sort: number;
visible: number;
children: Menu[];
}
/**
* 菜单表单类型声明
*/
export interface MenuForm {
/**
* 菜单ID
*/
id?: string;
/**
* 父菜单ID
*/
parentId: string;
/**
* 菜单名称
*/
name: string;
/**
* 菜单是否可见(1:是;0:否;)
*/
visible: number;
icon?: string;
/**
* 排序
*/
sort: number;
/**
* 组件路径
*/
component?: string;
/**
* 路由路径
*/
path: string;
/**
* 跳转路由路径
*/
redirect?: string;
/**
* 菜单类型
*/
type: string;
/**
* 权限标识
*/
perm?: string;
}
/**
* 资源(菜单+权限)类型
*/
export interface Resource {
/**
* 菜单值
*/
value: string;
/**
* 菜单文本
*/
label: string;
/**
* 子菜单
*/
children: Resource[];
}
/**
* 权限类型
*/
export interface Permission {
/**
* 权限值
*/
value: string;
/**
* 权限文本
*/
label: string;
}

21
src/api/role.ts → src/api/role/index.ts
View File

@@ -1,13 +1,6 @@
import {
RoleFormData,
RolePageResult,
RoleQueryParam,
RoleResource
} from '@/types/api/role';
import { Option } from '@/types/common';
import request from '@/utils/request';
import { AxiosPromise } from 'axios';
import { RoleQuery, RolePageResult, RoleForm } from './types';
/**
* 获取角色分页数据
@@ -15,7 +8,7 @@ import { AxiosPromise } from 'axios';
* @param queryParams
*/
export function listRolePages(
queryParams?: RoleQueryParam
queryParams?: RoleQuery
): AxiosPromise<RolePageResult> {
return request({
url: '/api/v1/roles/pages',
@@ -30,8 +23,8 @@ export function listRolePages(
* @param queryParams
*/
export function listRoleOptions(
queryParams?: RoleQueryParam
): AxiosPromise<Option[]> {
queryParams?: RoleQuery
): AxiosPromise<OptionType[]> {
return request({
url: '/api/v1/roles/options',
method: 'get',
@@ -72,7 +65,7 @@ export function updateRoleMenus(
*
* @param id
*/
export function getRoleFormDetail(id: number): AxiosPromise<RoleFormData> {
export function getRoleFormDetail(id: number): AxiosPromise<RoleForm> {
return request({
url: '/api/v1/roles/' + id,
method: 'get'
@@ -84,7 +77,7 @@ export function getRoleFormDetail(id: number): AxiosPromise<RoleFormData> {
*
* @param data
*/
export function addRole(data: RoleFormData) {
export function addRole(data: RoleForm) {
return request({
url: '/api/v1/roles',
method: 'post',
@@ -98,7 +91,7 @@ export function addRole(data: RoleFormData) {
* @param id
* @param data
*/
export function updateRole(id: number, data: RoleFormData) {
export function updateRole(id: number, data: RoleForm) {
return request({
url: '/api/v1/roles/' + id,
method: 'put',

40
src/api/role/types.ts Normal file
View File

@@ -0,0 +1,40 @@
/**
* 角色查询参数类型
*/
export interface RoleQuery extends PageQuery {
keywords?: string;
}
/**
* 角色分页列表项
*/
export interface Role {
id: string;
name: string;
code: string;
sort: number;
status: number;
deleted: number;
menuIds?: any;
permissionIds?: any;
}
/**
* 角色分页项类型
*/
export type RolePageResult = PageResult<Role[]>;
/**
* 角色表单类型
*/
export interface RoleForm {
id?: string;
name: string;
code: string;
sort: number;
status: number;
/**
* 数据权限
*/
dataScope: number;
}

15
src/api/user.ts → src/api/user/index.ts
View File

@@ -1,11 +1,6 @@
import request from '@/utils/request';
import { AxiosPromise } from 'axios';
import {
UserFormData,
UserInfo,
UserPageResult,
UserQueryParam
} from '@/types/api/user';
import { UserForm, UserInfo, UserPageResult, UserQuery } from './types';
/**
* 登录成功后获取用户信息（昵称、头像、权限集合和角色集合）
@@ -23,7 +18,7 @@ export function getUserInfo(): AxiosPromise<UserInfo> {
* @param queryParams
*/
export function listUserPages(
queryParams: UserQueryParam
queryParams: UserQuery
): AxiosPromise<UserPageResult> {
return request({
url: '/api/v1/users/pages',
@@ -37,7 +32,7 @@ export function listUserPages(
*
* @param userId
*/
export function getUserFormData(userId: number): AxiosPromise<UserFormData> {
export function getUserForm(userId: number): AxiosPromise<UserForm> {
return request({
url: '/api/v1/users/' + userId + '/form',
method: 'get'
@@ -63,7 +58,7 @@ export function addUser(data: any) {
* @param id
* @param data
*/
export function updateUser(id: number, data: UserFormData) {
export function updateUser(id: number, data: UserForm) {
return request({
url: '/api/v1/users/' + id,
method: 'put',
@@ -130,7 +125,7 @@ export function downloadTemplate() {
* @param queryParams
* @returns
*/
export function exportUser(queryParams: UserQueryParam) {
export function exportUser(queryParams: UserQuery) {
return request({
url: '/api/v1/users/_export',
method: 'get',

65
src/api/user/types.ts Normal file
View File

@@ -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[];
}