UNPKG

@clean-js/api-gen

Version:

[docs](https://lulusir.github.io/clean-js/api-gen/usage) [中文文档](https://github.com/lulusir/clean-js-api-gen/blob/main/README-zh.md)

94 lines (93 loc) 1.94 kB
import { OpenAPIV2 } from 'openapi-types'; export interface Yapi { index: number; name: string; desc: string; add_time: number; up_time: number; list: ListItem[]; basepath?: string; } export interface ListItem { query_path: QueryPath; edit_uid: number; status: Status; type: Type; req_body_is_json_schema: boolean; res_body_is_json_schema: boolean; api_opened: boolean; index: number; tag: any[]; _id: number; method: Method; catid: number; title: string; path: string; project_id: number; req_params: ReqParam[]; res_body_type: BodyType; uid: number; add_time: number; up_time: number; req_query: Req[]; req_headers: Req[]; req_body_form: Req[]; __v: number; desc?: string; markdown?: string; req_body_other?: string; req_body_type?: BodyType; res_body?: string; name?: string; } export declare enum Method { Delete = "DELETE", Get = "GET", Post = "POST", Put = "PUT", Patch = "PATCH" } export interface QueryPath { path: string; params: any[]; } export interface ReqHeader { required: string; _id: string; name: string; value: string; } export interface Req { required: string; _id: string; name: string; type?: string; example?: string; desc?: string; value?: any; } export declare enum BodyType { Form = "form", JSON = "json", file = "file", raw = "raw" } export interface ReqParam { _id: string; name: string; desc: string; } export declare enum Status { Done = "done", Undone = "undone" } export declare enum Type { Static = "static", Var = "var" } export declare class YAPIToSwagger { url: URL; constructor(url: string); convertToSwaggerV2Model(model: Yapi[]): Promise<OpenAPIV2.Document<{}>>; getApiLink(projectId: number, apiId: number): string; }