Skip to content

options 参数说明

ts
const options: {
    pathParams: ApiDetailParametersQuery[];
    pathParamsType: string;
    queryParams: ApiDetailParametersQuery[];
    queryParamsType: string;
    apiMethod: string;
    apiReturnType: string;
    haveReqBody: boolean;
    dataParamsType: string;
    apiFunctionName: string;
    extraFunctionName: string;
    apiPath: string;
    buildParameters:  (parameters: ApiDetailParametersQuery) => string;
    log: (errorMessage: string, type?: "Info" | "Warning" | "Error") => void;
}

参数说明:

参数名类型说明
pathParamsApiDetailParametersQuery[]路径参数(拼接在url上的参数,eg:v1/fine_tuning/jobs/{fine_tuning_job_id} fine_tuning_job_id是一个路径参数)
pathParamsTypestring路径参数的 TypeScript 类型名
queryParamsApiDetailParametersQuery[]接口的query参数
queryParamsTypestringquery参数的 TypeScript 类型名
apiMethodstring接口的请求方法(get/post等)
apiReturnTypestring接口请求返回值的 TypeScript 类型名
haveReqBodyboolean接口是否需要body请求体
dataParamsTypestringbody请求体的 TypeScript 类型名
apiFunctionNamestring接口方法的函数名
extraFunctionNamestring额外拓展的函数名
apiPathstring接口的请求地址
buildParameters(parameters: ApiDetailParametersQuery) => string将接口文档中的参数信息转换为 TypeScript 类型
log(errorMessage: string, type?: "Info" | "Warning" | "Error") => void日志输出,用于在编辑器中输出日志信息

基于 MIT 许可发布