Swagger / OpenAPI

@moostjs/swagger generates an OpenAPI 3 document from your Moost controllers and serves a Swagger UI — all driven by the decorators you already use.

Quick setup

npm install @moostjs/swagger swagger-ui-dist

import { Moost } from 'moost'
import { MoostHttp } from '@moostjs/event-http'
import { SwaggerController } from '@moostjs/swagger'

const app = new Moost()
app.adapter(new MoostHttp())
app.registerControllers(SwaggerController)
await app.init()

Open http://localhost:3000/api-docs to see the Swagger UI.

The generator automatically picks up @Controller, @Get/@Post/…, @Param, @Query, @Body, return types, and Atscript DTOs — so most endpoints are documented without any extra annotations.

Full documentation

For configuration options, decorator reference, schema customization, security schemes, and more, see the dedicated Swagger docs section.