github_mirrors/vue-vben-admin
1
0
Fork 0
mirror of https://github.com/vbenjs/vue-vben-admin.git synced 2025-02-02 18:28:40 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

feat: api suffix (#4065)

Browse Source
This commit is contained in:
sea 2024-08-07 13:42:33 +08:00 committed by GitHub
parent d9ba9917ff
commit 08391ad53e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/web-antd/src/api/core/auth.ts
View File

@ -21,13 +21,13 @@ export namespace AuthApi {
/** /**
* 登录 * 登录
*/ */
export async function login(data: AuthApi.LoginParams) { export async function loginApi(data: AuthApi.LoginParams) {
return requestClient.post<AuthApi.LoginResult>('/auth/login', data); return requestClient.post<AuthApi.LoginResult>('/auth/login', data);
} }
/** /**
* 获取用户权限码 * 获取用户权限码
*/ */
export async function getAccessCodes() { export async function getAccessCodesApi() {
return requestClient.get<string[]>('/auth/codes'); return requestClient.get<string[]>('/auth/codes');
} }

2
apps/web-antd/src/api/core/menu.ts
View File

@ -5,6 +5,6 @@ import { requestClient } from '#/api/request';
/** /**
* 获取用户所有菜单 * 获取用户所有菜单
*/ */
export async function getAllMenus() { export async function getAllMenusApi() {
return requestClient.get<RouteRecordStringComponent[]>('/menu/all'); return requestClient.get<RouteRecordStringComponent[]>('/menu/all');
} }

2
apps/web-antd/src/api/core/user.ts
View File

@ -5,6 +5,6 @@ import { requestClient } from '#/api/request';
/** /**
* 获取用户信息 * 获取用户信息
*/ */
export async function getUserInfo() { export async function getUserInfoApi() {
return requestClient.get<UserInfo>('/user/info'); return requestClient.get<UserInfo>('/user/info');
} }

4
apps/web-antd/src/api/demos/status.ts
View File

@ -3,8 +3,8 @@ import { requestClient } from '#/api/request';
/** /**
* 模拟任意状态码 * 模拟任意状态码
*/ */
async function getMockStatus(status: string) { async function getMockStatusApi(status: string) {
return requestClient.get('/status', { params: { status } }); return requestClient.get('/status', { params: { status } });
} }
export { getMockStatus }; export { getMockStatusApi };

4
apps/web-antd/src/router/access.ts
View File

@ -8,7 +8,7 @@ import { preferences } from '@vben/preferences';
import { message } from 'ant-design-vue'; import { message } from 'ant-design-vue';
import { getAllMenus } from '#/api'; import { getAllMenusApi } from '#/api';
import { BasicLayout, IFrameView } from '#/layouts'; import { BasicLayout, IFrameView } from '#/layouts';
import { $t } from '#/locales'; import { $t } from '#/locales';
@ -29,7 +29,7 @@ async function generateAccess(options: GenerateMenuAndRoutesOptions) {
content: `${$t('common.loadingMenu')}...`, content: `${$t('common.loadingMenu')}...`,
duration: 1.5, duration: 1.5,
}); });
return await getAllMenus(); return await getAllMenusApi();
}, },
// 可以指定没有权限跳转403页面 // 可以指定没有权限跳转403页面
forbiddenComponent, forbiddenComponent,

8
apps/web-antd/src/store/auth.ts
View File

@ -10,7 +10,7 @@ import { resetAllStores, useAccessStore, useUserStore } from '@vben/stores';
import { notification } from 'ant-design-vue'; import { notification } from 'ant-design-vue';
import { defineStore } from 'pinia'; import { defineStore } from 'pinia';
import { getAccessCodes, getUserInfo, login } from '#/api'; import { getAccessCodesApi, getUserInfoApi, loginApi } from '#/api';
import { $t } from '#/locales'; import { $t } from '#/locales';
export const useAuthStore = defineStore('auth', () => { export const useAuthStore = defineStore('auth', () => {
@ -33,7 +33,7 @@ export const useAuthStore = defineStore('auth', () => {
let userInfo: null | UserInfo = null; let userInfo: null | UserInfo = null;
try { try {
loginLoading.value = true; loginLoading.value = true;
const { accessToken, refreshToken } = await login(params); const { accessToken, refreshToken } = await loginApi(params);
// 如果成功获取到 accessToken // 如果成功获取到 accessToken
if (accessToken) { if (accessToken) {
@ -44,7 +44,7 @@ export const useAuthStore = defineStore('auth', () => {
// 获取用户信息并存储到 accessStore 中 // 获取用户信息并存储到 accessStore 中
const [fetchUserInfoResult, accessCodes] = await Promise.all([ const [fetchUserInfoResult, accessCodes] = await Promise.all([
fetchUserInfo(), fetchUserInfo(),
getAccessCodes(), getAccessCodesApi(),
]); ]);
userInfo = fetchUserInfoResult; userInfo = fetchUserInfoResult;
@ -92,7 +92,7 @@ export const useAuthStore = defineStore('auth', () => {
async function fetchUserInfo() { async function fetchUserInfo() {
let userInfo: null | UserInfo = null; let userInfo: null | UserInfo = null;
userInfo = await getUserInfo(); userInfo = await getUserInfoApi();
userStore.setUserInfo(userInfo); userStore.setUserInfo(userInfo);
return userInfo; return userInfo;
} }

4
apps/web-antd/src/views/demos/features/login-expired/index.vue
View File

@ -5,13 +5,13 @@ import { preferences, updatePreferences } from '@vben/preferences';
import { Button } from 'ant-design-vue'; import { Button } from 'ant-design-vue';
import { getMockStatus } from '#/api'; import { getMockStatusApi } from '#/api';
async function handleClick(type: LoginExpiredModeType) { async function handleClick(type: LoginExpiredModeType) {
const loginExpiredMode = preferences.app.loginExpiredMode; const loginExpiredMode = preferences.app.loginExpiredMode;
updatePreferences({ app: { loginExpiredMode: type } }); updatePreferences({ app: { loginExpiredMode: type } });
await getMockStatus('401'); await getMockStatusApi('401');
updatePreferences({ app: { loginExpiredMode } }); updatePreferences({ app: { loginExpiredMode } });
} }
</script> </script>

4
apps/web-ele/src/api/core/auth.ts
View File

@ -21,13 +21,13 @@ export namespace AuthApi {
/** /**
* 登录 * 登录
*/ */
export async function login(data: AuthApi.LoginParams) { export async function loginApi(data: AuthApi.LoginParams) {
return requestClient.post<AuthApi.LoginResult>('/auth/login', data); return requestClient.post<AuthApi.LoginResult>('/auth/login', data);
} }
/** /**
* 获取用户权限码 * 获取用户权限码
*/ */
export async function getAccessCodes() { export async function getAccessCodesApi() {
return requestClient.get<string[]>('/auth/codes'); return requestClient.get<string[]>('/auth/codes');
} }

2
apps/web-ele/src/api/core/menu.ts
View File

@ -5,6 +5,6 @@ import { requestClient } from '#/api/request';
/** /**
* 获取用户所有菜单 * 获取用户所有菜单
*/ */
export async function getAllMenus() { export async function getAllMenusApi() {
return requestClient.get<RouteRecordStringComponent[]>('/menu/all'); return requestClient.get<RouteRecordStringComponent[]>('/menu/all');
} }

2
apps/web-ele/src/api/core/user.ts
View File

@ -5,6 +5,6 @@ import { requestClient } from '#/api/request';
/** /**
* 获取用户信息 * 获取用户信息
*/ */
export async function getUserInfo() { export async function getUserInfoApi() {
return requestClient.get<UserInfo>('/user/info'); return requestClient.get<UserInfo>('/user/info');
} }

4
apps/web-ele/src/router/access.ts
View File

@ -8,7 +8,7 @@ import { preferences } from '@vben/preferences';
import { ElMessage } from 'element-plus'; import { ElMessage } from 'element-plus';
import { getAllMenus } from '#/api'; import { getAllMenusApi } from '#/api';
import { BasicLayout, IFrameView } from '#/layouts'; import { BasicLayout, IFrameView } from '#/layouts';
import { $t } from '#/locales'; import { $t } from '#/locales';
@ -29,7 +29,7 @@ async function generateAccess(options: GenerateMenuAndRoutesOptions) {
duration: 1500, duration: 1500,
message: `${$t('common.loadingMenu')}...`, message: `${$t('common.loadingMenu')}...`,
}); });
return await getAllMenus(); return await getAllMenusApi();
}, },
// 可以指定没有权限跳转403页面 // 可以指定没有权限跳转403页面
forbiddenComponent, forbiddenComponent,

8
apps/web-ele/src/store/auth.ts
View File

@ -10,7 +10,7 @@ import { resetAllStores, useAccessStore, useUserStore } from '@vben/stores';
import { ElNotification } from 'element-plus'; import { ElNotification } from 'element-plus';
import { defineStore } from 'pinia'; import { defineStore } from 'pinia';
import { getAccessCodes, getUserInfo, login } from '#/api'; import { getAccessCodesApi, getUserInfoApi, loginApi } from '#/api';
import { $t } from '#/locales'; import { $t } from '#/locales';
export const useAuthStore = defineStore('auth', () => { export const useAuthStore = defineStore('auth', () => {
@ -33,7 +33,7 @@ export const useAuthStore = defineStore('auth', () => {
let userInfo: null | UserInfo = null; let userInfo: null | UserInfo = null;
try { try {
loginLoading.value = true; loginLoading.value = true;
const { accessToken, refreshToken } = await login(params); const { accessToken, refreshToken } = await loginApi(params);
// 如果成功获取到 accessToken // 如果成功获取到 accessToken
if (accessToken) { if (accessToken) {
@ -44,7 +44,7 @@ export const useAuthStore = defineStore('auth', () => {
// 获取用户信息并存储到 accessStore 中 // 获取用户信息并存储到 accessStore 中
const [fetchUserInfoResult, accessCodes] = await Promise.all([ const [fetchUserInfoResult, accessCodes] = await Promise.all([
fetchUserInfo(), fetchUserInfo(),
getAccessCodes(), getAccessCodesApi(),
]); ]);
userInfo = fetchUserInfoResult; userInfo = fetchUserInfoResult;
@ -92,7 +92,7 @@ export const useAuthStore = defineStore('auth', () => {
async function fetchUserInfo() { async function fetchUserInfo() {
let userInfo: null | UserInfo = null; let userInfo: null | UserInfo = null;
userInfo = await getUserInfo(); userInfo = await getUserInfoApi();
userStore.setUserInfo(userInfo); userStore.setUserInfo(userInfo);
return userInfo; return userInfo;
} }

4
apps/web-naive/src/api/core/auth.ts
View File

@ -21,13 +21,13 @@ export namespace AuthApi {
/** /**
* 登录 * 登录
*/ */
export async function login(data: AuthApi.LoginParams) { export async function loginApi(data: AuthApi.LoginParams) {
return requestClient.post<AuthApi.LoginResult>('/auth/login', data); return requestClient.post<AuthApi.LoginResult>('/auth/login', data);
} }
/** /**
* 获取用户权限码 * 获取用户权限码
*/ */
export async function getAccessCodes() { export async function getAccessCodesApi() {
return requestClient.get<string[]>('/auth/codes'); return requestClient.get<string[]>('/auth/codes');
} }

2
apps/web-naive/src/api/core/menu.ts
View File

@ -5,6 +5,6 @@ import { requestClient } from '#/api/request';
/** /**
* 获取用户所有菜单 * 获取用户所有菜单
*/ */
export async function getAllMenus() { export async function getAllMenusApi() {
return requestClient.get<RouteRecordStringComponent[]>('/menu/all'); return requestClient.get<RouteRecordStringComponent[]>('/menu/all');
} }

2
apps/web-naive/src/api/core/user.ts
View File

@ -5,6 +5,6 @@ import { requestClient } from '#/api/request';
/** /**
* 获取用户信息 * 获取用户信息
*/ */
export async function getUserInfo() { export async function getUserInfoApi() {
return requestClient.get<UserInfo>('/user/info'); return requestClient.get<UserInfo>('/user/info');
} }

4
apps/web-naive/src/router/access.ts
View File

@ -6,7 +6,7 @@ import type {
import { generateAccessible } from '@vben/access'; import { generateAccessible } from '@vben/access';
import { preferences } from '@vben/preferences'; import { preferences } from '@vben/preferences';
import { getAllMenus } from '#/api'; import { getAllMenusApi } from '#/api';
import { BasicLayout, IFrameView } from '#/layouts'; import { BasicLayout, IFrameView } from '#/layouts';
import { $t } from '#/locales'; import { $t } from '#/locales';
import { message } from '#/naive'; import { message } from '#/naive';
@ -27,7 +27,7 @@ async function generateAccess(options: GenerateMenuAndRoutesOptions) {
message.loading(`${$t('common.loadingMenu')}...`, { message.loading(`${$t('common.loadingMenu')}...`, {
duration: 1.5, duration: 1.5,
}); });
return await getAllMenus(); return await getAllMenusApi();
}, },
// 可以指定没有权限跳转403页面 // 可以指定没有权限跳转403页面
forbiddenComponent, forbiddenComponent,

8
apps/web-naive/src/store/auth.ts
View File

@ -9,7 +9,7 @@ import { resetAllStores, useAccessStore, useUserStore } from '@vben/stores';
import { defineStore } from 'pinia'; import { defineStore } from 'pinia';
import { getAccessCodes, getUserInfo, login } from '#/api'; import { getAccessCodesApi, getUserInfoApi, loginApi } from '#/api';
import { $t } from '#/locales'; import { $t } from '#/locales';
import { notification } from '#/naive'; import { notification } from '#/naive';
@ -33,7 +33,7 @@ export const useAuthStore = defineStore('auth', () => {
let userInfo: null | UserInfo = null; let userInfo: null | UserInfo = null;
try { try {
loginLoading.value = true; loginLoading.value = true;
const { accessToken, refreshToken } = await login(params); const { accessToken, refreshToken } = await loginApi(params);
// 如果成功获取到 accessToken // 如果成功获取到 accessToken
if (accessToken) { if (accessToken) {
@ -44,7 +44,7 @@ export const useAuthStore = defineStore('auth', () => {
// 获取用户信息并存储到 accessStore 中 // 获取用户信息并存储到 accessStore 中
const [fetchUserInfoResult, accessCodes] = await Promise.all([ const [fetchUserInfoResult, accessCodes] = await Promise.all([
fetchUserInfo(), fetchUserInfo(),
getAccessCodes(), getAccessCodesApi(),
]); ]);
userInfo = fetchUserInfoResult; userInfo = fetchUserInfoResult;
@ -92,7 +92,7 @@ export const useAuthStore = defineStore('auth', () => {
async function fetchUserInfo() { async function fetchUserInfo() {
let userInfo: null | UserInfo = null; let userInfo: null | UserInfo = null;
userInfo = await getUserInfo(); userInfo = await getUserInfoApi();
userStore.setUserInfo(userInfo); userStore.setUserInfo(userInfo);
return userInfo; return userInfo;
} }

10
docs/src/guide/essentials/server.md
View File

@ -117,7 +117,7 @@ VITE_GLOB_API_URL=https://mock-napi.vben.pro/api
```ts ```ts
import { requestClient } from '#/api/request'; import { requestClient } from '#/api/request';
export async function getUserInfo() { export async function getUserInfoApi() {
return requestClient.get<UserInfo>('/user/info'); return requestClient.get<UserInfo>('/user/info');
} }
``` ```
@ -127,15 +127,15 @@ export async function getUserInfo() {
```ts ```ts
import { requestClient } from '#/api/request'; import { requestClient } from '#/api/request';
export async function saveUser(user: UserInfo) { export async function saveUserApi(user: UserInfo) {
return requestClient.post<UserInfo>('/user', user); return requestClient.post<UserInfo>('/user', user);
} }
export async function saveUser(user: UserInfo) { export async function saveUserApi(user: UserInfo) {
return requestClient.put<UserInfo>('/user', user); return requestClient.put<UserInfo>('/user', user);
} }
export async function saveUser(user: UserInfo) { export async function saveUserApi(user: UserInfo) {
const url = user.id ? `/user/${user.id}` : '/user/'; const url = user.id ? `/user/${user.id}` : '/user/';
return requestClient.request<UserInfo>(url, { return requestClient.request<UserInfo>(url, {
data: user, data: user,
@ -150,7 +150,7 @@ export async function saveUser(user: UserInfo) {
```ts ```ts
import { requestClient } from '#/api/request'; import { requestClient } from '#/api/request';
export async function deleteUser(user: UserInfo) { export async function deleteUserApi(user: UserInfo) {
return requestClient.delete<boolean>(`/user/${user.id}`, user); return requestClient.delete<boolean>(`/user/${user.id}`, user);
} }
``` ```