Deepkit API Console

npms install @deepkit/api-console-module

Automatische Dokumentation der HTTP- und RPC-API, die alle routes, actions, parameters, return types und status codes in TypeScript type syntax anzeigt.

Es ist Teil des Framework Debugger, kann aber auch eigenständig verwendet werden.

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

new App({
    imports: [
        new ApiConsoleModule({
            path: '/api',
            markdown: `
        # Meine API
        
        Dies ist meine API-Dokumentation.
        
        Viel Spaß!
        `
        }),
    ]
})

Standardmäßig zeigt new ApiConsoleModule alle HTTP- und RPC-routes an. Sie können außerdem festlegen, welche routes angezeigt werden sollen, indem Sie die Methoden der ApiConsoleModule Class verwenden.

Classes

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