Deepkit API 控制台

npms install @deepkit/api-console-module

HTTP 和 RPC API 的自动文档，以 TypeScript 类型语法展示所有路由、操作、参数、返回类型、状态码。

它是框架调试器的一部分，但也可以单独使用。

import { ApiConsoleModule } from '@deepkit/api-console-module';

new App({
    imports: [
        new ApiConsoleModule({
            path: '/api',
            markdown: `
        # My API
        
        This is my API documentation.
        
        Have fun!
        `
        }),
    ]
})

默认情况下，new ApiConsoleModule 会显示所有 HTTP 和 RPC 路由。你也可以通过 ApiConsoleModule 类上的方法指定要显示的路由。

Classes

ApiConsoleModule

Classes

export class ApiConsoleModule extends createModuleClass({
    name: , config: Config,
}) {
    filter(cb: (filter: HttpRouteFilter) => any): this;
    process();
}

English 中文 (Chinese)한국어 (Korean)日本語 (Japanese)Deutsch (German)