# Deepkit API コンソール

```bash
npms install @deepkit/api-console-module
```

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

これは [フレームワークデバッガー](https://deepkit.io/ja/documentation/framework.md) の一部ですが、単体でも使用できます。

```typescript
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 を指定することもできます。


![](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