Skip to content

B
basic-vue-admin
提交 e5d52ef5 作者: 方治民
操作

refactor: 更新 API 自动生成可选参数

上级 9b9d1dda
正在显示 包含 214 行增加 和 34 行删除
src/api/services/api-lock.json
......@@ -397,6 +397,32 @@
}
}
]
},
{
"description": "测试 MyBatis Plus 查询",
"name": "test",
"method": "get",
"path": "/api/hello/test",
"response": {
"typeArgs": [
{
"typeArgs": [],
"typeName": "string",
"isDefsType": false,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
}
],
"typeName": "Result",
"isDefsType": true,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
},
"parameters": []
}
],
"name": "hello"
......@@ -605,6 +631,21 @@
},
{
"in": "query",
"description": "重定向",
"name": "redirect",
"required": false,
"dataType": {
"typeArgs": [],
"typeName": "string",
"isDefsType": false,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
}
},
{
"in": "query",
"description": "序号",
"name": "serial",
"required": false,
......@@ -906,6 +947,21 @@
},
{
"in": "query",
"description": "重定向",
"name": "redirect",
"required": false,
"dataType": {
"typeArgs": [],
"typeName": "string",
"isDefsType": false,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
}
},
{
"in": "query",
"description": "序号",
"name": "serial",
"required": false,
......@@ -1541,7 +1597,7 @@
"description": "",
"interfaces": [
{
"description": "获取用户权限",
"description": "获取用户菜单",
"name": "getMenuList",
"method": "get",
"path": "/api/user/getMenuList",
......@@ -1577,6 +1633,42 @@
"parameters": []
},
{
"description": "获取用户权限",
"name": "getPermCode",
"method": "get",
"path": "/api/user/getPermCode",
"response": {
"typeArgs": [
{
"typeArgs": [
{
"typeArgs": [],
"typeName": "string",
"isDefsType": false,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
}
],
"typeName": "Array",
"isDefsType": false,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
}
],
"typeName": "Result",
"isDefsType": true,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [],
"typeProperties": []
},
"parameters": []
},
{
"description": "获取登录用户信息",
"name": "getUserInfo",
"method": "get",
......@@ -1886,7 +1978,7 @@
"typeProperties": []
},
"name": "name",
"description": "标识",
"description": "名称",
"required": false
},
{
......@@ -1906,19 +1998,15 @@
{
"dataType": {
"typeArgs": [],
"typeName": "",
"typeName": "string",
"isDefsType": false,
"templateIndex": -1,
"compileTemplateKeyword": "#/definitions/",
"enum": [
"'DIR'",
"'MENU'",
"'BUTTON'"
],
"enum": [],
"typeProperties": []
},
"name": "type",
"description": "权限类型",
"name": "redirect",
"description": "重定向",
"required": false
}
],
......
src/api/services/api.d.ts
......@@ -21,14 +21,14 @@ declare namespace defs {
/** 元数据 */
meta?: ObjectMap<any, object>
/** 标识 */
/** 名称 */
name?: string
/** 路径 */
path?: string
/** 权限类型 */
type?: 'DIR' | 'MENU' | 'BUTTON'
/** 重定向 */
redirect?: string
}
export class PageVo<T0 = any> {
......@@ -225,7 +225,7 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
......@@ -283,7 +283,7 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
......@@ -301,7 +301,7 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
......@@ -333,6 +333,24 @@ declare namespace API {
options?: http.RequestOptions,
): Promise<Response>
}
/**
* 测试 MyBatis Plus 查询
* /api/hello/test
*/
export namespace test {
export class Params {}
export type Response = string
export const init: Response
export function request(
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
}
}
/**
......@@ -351,7 +369,7 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
form: FormData,
config?: http.RequestConfig<Params | FormData>,
options?: http.RequestOptions,
......@@ -385,6 +403,8 @@ declare namespace API {
path?: string
/** 父级ID */
pid?: number
/** 重定向 */
redirect?: string
/** 序号 */
serial?: number
/** 权限类型 */
......@@ -470,6 +490,8 @@ declare namespace API {
path?: string
/** 父级ID */
pid?: number
/** 重定向 */
redirect?: string
/** 序号 */
serial?: number
/** 权限类型 */
......@@ -694,7 +716,7 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
......@@ -706,7 +728,7 @@ declare namespace API {
*/
export namespace user {
/**
* 获取用户权限
* 获取用户菜单
* /api/user/getMenuList
*/
export namespace getMenuList {
......@@ -717,7 +739,25 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
}
/**
* 获取用户权限
* /api/user/getPermCode
*/
export namespace getPermCode {
export class Params {}
export type Response = Array<string>
export const init: Response
export function request(
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
......@@ -735,7 +775,7 @@ declare namespace API {
export const init: Response
export function request(
params: Params,
params?: Params,
config?: http.RequestConfig<Params>,
options?: http.RequestOptions,
): Promise<Response>
......
src/api/services/baseClass.ts
......@@ -16,14 +16,14 @@ export class MenuVo {
/** 元数据 */
meta = undefined
/** 标识 */
/** 名称 */
name = ''
/** 路径 */
path = ''
/** 权限类型 */
type = 'DIR'
/** 重定向 */
redirect = ''
}
export class PageVo {
......
src/api/services/mods/auth/logout.ts
......@@ -9,7 +9,7 @@ export class Params {}
export const init = new defs.Result()
export function request(params: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/auth/logout',
......
src/api/services/mods/hello/fail.ts
......@@ -9,7 +9,7 @@ export class Params {}
export const init = new defs.Result()
export function request(params: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/hello/fail',
......
src/api/services/mods/hello/hello.ts
......@@ -9,7 +9,7 @@ export class Params {}
export const init = new defs.Result()
export function request(params: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/hello/',
......
src/api/services/mods/hello/index.ts
......@@ -4,5 +4,6 @@
import * as hello from './hello'
import * as fail from './fail'
import * as page from './page'
import * as test from './test'
export { hello, fail, page }
export { hello, fail, page, test }
src/api/services/mods/hello/test.ts 0 → 100644
/**
* @desc 测试 MyBatis Plus 查询
*/
import * as defs from '../../baseClass'
import { defHttp } from '/@/utils/http/axios'
export class Params {}
export const init = new defs.Result()
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/hello/test',
method: 'GET',
params,
...config,
},
options,
)
}
src/api/services/mods/minio/upload.ts
......@@ -10,7 +10,7 @@ export class Params {}
export const init = new defs.Result()
export function request(
params: Params,
params?: Params,
form: FormData,
config?: http.RequestConfig<Params | FormData>,
options?: http.RequestOptions,
......
src/api/services/mods/permission/add.ts
......@@ -22,6 +22,8 @@ export class Params {
path?: string
/** 父级ID */
pid?: number
/** 重定向 */
redirect?: string
/** 序号 */
serial?: number
/** 权限类型 */
......
src/api/services/mods/permission/modify.ts
......@@ -24,6 +24,8 @@ export class Params {
path?: string
/** 父级ID */
pid?: number
/** 重定向 */
redirect?: string
/** 序号 */
serial?: number
/** 权限类型 */
......
src/api/services/mods/role/selector.ts
......@@ -9,7 +9,7 @@ export class Params {}
export const init = new defs.Result()
export function request(params: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/manage/role/selector',
......
src/api/services/mods/user/getMenuList.ts
/**
* @desc 获取用户权限
* @desc 获取用户菜单
*/
import * as defs from '../../baseClass'
......@@ -9,7 +9,7 @@ export class Params {}
export const init = new defs.Result()
export function request(params: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/user/getMenuList',
......
src/api/services/mods/user/getPermCode.ts 0 → 100644
/**
* @desc 获取用户权限
*/
import * as defs from '../../baseClass'
import { defHttp } from '/@/utils/http/axios'
export class Params {}
export const init = new defs.Result()
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/user/getPermCode',
method: 'GET',
params,
...config,
},
options,
)
}
src/api/services/mods/user/getUserInfo.ts
......@@ -9,7 +9,7 @@ export class Params {}
export const init = new defs.Result()
export function request(params: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
export function request(params?: Params, config?: http.RequestConfig<Params>, options?: http.RequestOptions) {
return defHttp.request(
{
url: '/user/getUserInfo',
......
src/api/services/mods/user/index.ts
......@@ -2,8 +2,9 @@
* @description
*/
import * as getMenuList from './getMenuList'
import * as getPermCode from './getPermCode'
import * as getUserInfo from './getUserInfo'
import * as assign from './assign'
import * as page from './page'
export { getMenuList, getUserInfo, assign, page }
export { getMenuList, getPermCode, getUserInfo, assign, page }
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论