# Deepkit API Console

```bash
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](https://deepkit.io/de/documentation/framework.md), kann aber auch eigenständig verwendet werden.

```typescript
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.


![](https://deepkit.io/assets/screenshots/api-console-http-get.png)
![](https://deepkit.io/assets/screenshots/api-console-http-post.png)
![](https://deepkit.io/assets/screenshots/api-console-overview.png)
![](https://deepkit.io/assets/screenshots/api-console-overview-detail.png)
![](https://deepkit.io/assets/screenshots/api-console-overview-detail-get.png)


## API reference of @deepkit/api-console-module

### ApiConsoleModule (class)

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

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/api-console-module/src/module.ts#L10