Deepkit API Console

npms install @deepkit/api-console-module

Auto documentation of HTTP and RPC API showing all routes, actions, parameters, return types, status codes, in TypeScript type syntax.

It is part of Framework Debugger but can also be used standalone.

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

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

Per default new ApiConsoleModule shows all HTTP and RPC routes. You can also specify which routes should be shown using the methods on the ApiConsoleModule class.

Classes

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