# Deepkit API Console

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

HTTP 및 RPC API의 모든 routes, actions, parameters, return types, status codes를 TypeScript type syntax로 보여주는 자동 문서화.

이는 [Framework Debugger](https://deepkit.io/ko/documentation/framework.md)의 일부이지만 독립적으로도 사용할 수 있습니다.

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

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

기본적으로 `new ApiConsoleModule`은 모든 HTTP 및 RPC routes를 보여줍니다. 또한 `ApiConsoleModule` Class의 Method들을 사용하여 어떤 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