/** * Copyright 2019-2021 u14.com * MIT Licensed */ /** * api文档相关函数 */ import { ApiParamRule } from "./api_ctx"; export declare function html2line(source: string): string; export declare function genarateDocsHtml(cfg: { api?: string; group?: string; assetLocalDir?: string; docPath?: string; project?: string; groups?: { [index: string]: string; }; globalArgs?: string[]; }): string; /** * 生成-API文档列表 * @param project * @param docs * @param group * @param groupNameMap * @param comporess * @param doc_res_dir */ export declare function docs_list(project: string, docs: { [index: string]: DocNode; }, group?: string, groupNameMap?: { [index: string]: string; }, comporess?: boolean, doc_res_dir?: string, docPagePath?: string): string; /** * 单个接口的文档 * @param url * @param node * @param comporess * @param globalVars * @param doc_res_dir */ export declare function docs_desc(url: string, node: DocApiNode, comporess?: boolean, globalVars?: any[], doc_res_dir?: string): string; export interface DocNode { name: string; method: string; cms?: { group: string; desc: string; state: string; }; list: Array<{ method?: string; path: string; code: number; rules: Array; name: string; cms?: { group: string; desc: string; params: { [index: string]: string; }; returns: [{ name: string; desc: string; }]; tpls: [{ name: string; desc: string; }]; state: string; }; }>; } interface DocApiNode { method?: string; name: string; path: string; code: number; rules: Array; cms?: { group: string; desc: string; params: { [index: string]: string; }; returns: [{ name: string; desc: string; }]; tpls: [{ name: string; desc: string; }]; state: string; }; } export {};