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

feat: 添加API接口TypeScript类型描述文件

Browse Source
This commit is contained in:
郝先瑞
2022-03-13 15:42:59 +08:00
parent 454e9856e3
commit 9a812c02dd
9 changed files with 72 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/api/system/dict.ts
View File

@@ -1,11 +1,13 @@
import { DictFormData, DictItemFormData, DictItemPageResult, DictItemQueryParam, DictPageResult, DictQueryParam, Option } from "@/types";
import request from "@/utils/request";
import { AxiosPromise } from "axios";
/**
* 获取字典分页列表
*
* @param queryParams
*/
export function listDictWithPage(queryParams: object) {
export function listDictPages(queryParams: DictQueryParam): AxiosPromise<DictPageResult> {
return request({
url: '/youlai-admin/api/v2/dict/page',
method: 'get',
@@ -18,7 +20,7 @@ export function listDictWithPage(queryParams: object) {
*
* @param id
*/
export function getDictDetail(id: number) {
export function getDictFormDetail(id: number): AxiosPromise<DictFormData> {
return request({
url: '/youlai-admin/api/v2/dict/' + id,
method: 'get'
@@ -31,7 +33,7 @@ export function getDictDetail(id: number) {
*
* @param data
*/
export function addDict(data: object) {
export function addDict(data: DictFormData) {
return request({
url: '/youlai-admin/api/v2/dict',
method: 'post',
@@ -45,7 +47,7 @@ export function addDict(data: object) {
* @param id
* @param data
*/
export function updateDict(id: number, data: object) {
export function updateDict(id: number, data: DictFormData) {
return request({
url: '/youlai-admin/api/v2/dict/' + id,
method: 'put',
@@ -69,7 +71,7 @@ export function deleteDict(ids: string) {
*
* @param queryParams
*/
export function listDictItemsWithPage(queryParams: object) {
export function listDictItemPages(queryParams: DictItemQueryParam): AxiosPromise<DictItemPageResult> {
return request({
url: '/youlai-admin/api/v2/dict/items/page',
method: 'get',
@@ -83,11 +85,11 @@ export function listDictItemsWithPage(queryParams: object) {
*
* @param dictCode
*/
export function listDictsByCode(dictCode: string) {
export function listDictsByCode(dictCode: string): AxiosPromise<Option[]> {
return request({
url: '/youlai-admin/api/v2/dict/items',
method: 'get',
params: {dictCode: dictCode}
params: { dictCode: dictCode }
})
}
@@ -96,7 +98,7 @@ export function listDictsByCode(dictCode: string) {
*
* @param id
*/
export function getDictItemDetail(id: number) {
export function getDictItemDetail(id: number): AxiosPromise<DictItemFormData> {
return request({
url: '/youlai-admin/api/v2/dict/items/' + id,
method: 'get'
@@ -110,7 +112,7 @@ export function getDictItemDetail(id: number) {
*
* @param data
*/
export function addDictItem(data: object) {
export function addDictItem(data: DictFormData) {
return request({
url: '/youlai-admin/api/v2/dict/items',
method: 'post',
@@ -124,7 +126,7 @@ export function addDictItem(data: object) {
* @param id
* @param data
*/
export function updateDictItem(id: number, data: object) {
export function updateDictItem(id: number, data: DictFormData) {
return request({
url: '/youlai-admin/api/v2/dict/items/' + id,
method: 'put',