@zhangzhao1102/yapi-mcp-server
Version:
YApi MCP Server - 用于与YApi接口管理平台交互的MCP服务器
108 lines • 2.46 kB
TypeScript
export interface YApiProject {
_id: number;
name: string;
desc: string;
basepath: string;
project_type: string;
uid: number;
group_id: number;
icon: string;
color: string;
project_mock_script: string;
is_mock_open: number;
is_json5: number;
switch_notice: number;
is_swagger: number;
is_data_mock: number;
created_at: string;
updated_at: string;
}
export interface YApiInterface {
_id: number;
title: string;
path: string;
method: string;
desc: string;
project_id: number;
catid: number;
uid: number;
add_time: number;
up_time: number;
index: number;
status: 'undone' | 'done';
type: string;
req_body_type: 'form' | 'json' | 'file' | 'raw';
res_body_type: string;
res_body: string;
req_body_other: string;
req_headers: any[];
req_query: any[];
req_body_form: any[];
req_params: any[];
res_body_is_json_schema: boolean;
req_body_is_json_schema: boolean;
api_opened: boolean;
test_result: any;
}
export interface YApiCategory {
_id: number;
name: string;
desc: string;
project_id: number;
uid: number;
add_time: number;
up_time: number;
index: number;
}
export interface YApiResponse<T = any> {
errcode: number;
errmsg: string;
data: T;
}
export interface ProjectListParams {
group_id?: number;
page?: number;
limit?: number;
}
export interface InterfaceListParams {
project_id?: number;
catid?: number;
page?: number;
limit?: number;
}
export interface CreateInterfaceParams {
project_id: number;
catid: number;
title: string;
path: string;
method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
desc?: string;
req_body_type?: 'form' | 'json' | 'file' | 'raw';
status?: 'undone' | 'done';
}
export interface UpdateInterfaceParams {
interface_id: number;
title?: string;
path?: string;
method?: string;
desc?: string;
status?: 'undone' | 'done';
}
export interface CreateCategoryParams {
project_id: number;
name: string;
desc?: string;
}
export interface TestInterfaceParams {
interface_id: number;
env?: string;
params?: Record<string, any>;
}
export interface YApiConfig {
baseUrl?: string;
username?: string;
password?: string;
token?: string;
uid?: string;
}
//# sourceMappingURL=index.d.ts.map