# Deepkit API 控制台

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

HTTP 和 RPC API 的自动文档，以 TypeScript 类型语法展示所有路由、操作、参数、返回类型、状态码。

它是 [框架调试器](https://deepkit.io/zh/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 路由。你也可以通过 `ApiConsoleModule` 类上的方法指定要显示的路由。


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