Deepkit API コンソール // package // Deepkit Enterprise TypeScript Framework

Deepkit API コンソール

npms install @deepkit/api-console-module

HTTP と RPC API の自動ドキュメント化。TypeScript の type 構文で、すべての routes、actions、parameters、return types、status codes を表示します。

これはフレームワークデバッガーの一部ですが、単体でも使用できます。

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

new App({
    imports: [
        new ApiConsoleModule({
            path: '/api',
            markdown: `
        # 私の API
        
        これは私の API ドキュメントです。
        
        お楽しみください！
        `
        }),
    ]
})

デフォルトでは new ApiConsoleModule はすべての HTTP および RPC routes を表示します。ApiConsoleModule Class の methods を使って、表示する routes を指定することもできます。

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

Deepkit API コンソール

Classes