ts-api-core/controller/route.doc.controller.d.ts

Nodejs api framework core

import { Response } from "express";
import { RequestData, RequestResultFiled } from '../base/reqest.data';
import { BaseController } from './base.controller';
export interface IDocStyleConfig {
    themeColor?: string;
    tocBgColor?: string;
    tocWidth?: string;
    inputWidth?: string;
    customCss?: string;
}
/**
 * 接口文档服务
 */
export declare class RouteDocController extends BaseController {
    static routeMap?: Map<string, RequestData>;
    getRoute(path?: string): RequestData | undefined;
    getBaseUrl(route: RequestData, server?: any): string;
    get pageTitle(): string;
    config(resp: Response, path?: string): Promise<any>;
    /** 配置样式获取 */
    docStyleConfig?: () => IDocStyleConfig;
    /** 配置样式获取 */
    docStyleHandler?: () => string;
    docCssStyle(resp: Response): Promise<any>;
    doc(resp: Response, path?: string): Promise<any>;
    docList(resp: Response, path?: string): Promise<any>;
    docHtml(resp: Response, path?: string): Promise<any>;
    /** 目录信息 */
    handleToc(): Promise<any>;
    /** 目录信息 */
    getApiData(resp: Response, path?: string): Promise<any>;
    docListHtml(resp: Response): Promise<any>;
    private getHtmlData;
    private getMarkdownApiGroupResult;
    /** 获取 api 列表 markdown 文档内容 */
    private getMarkdownApiListResult;
    /** 获取 markdown 文档内容 */
    private getMarkdownResult;
    private getQueryParamList;
    private getBodyParamList;
    static defaultResultFrame: RequestResultFiled[];
    private getHeadersList;
    private getResponseList;
    private getResponseListByFields;
}