API

path: /src/entrypoints/api.ts

Controllers

The API Module includes all other modules that have a controller.

const app = await NestFactory.create(ApiModule, adapter)

Versioning

API versioning manages changes to an API over time, ensuring backward compatibility and allowing updates without breaking existing applications. It helps introduce new features, fix bugs, and deprecate older versions.

By default, all endpoints are exposed under api/v1.

app.setGlobalPrefix('api', {
    exclude: []
})
app.enableVersioning({
    type: VersioningType.URI,
    defaultVersion: '1'
})

When you want to make a v2 version of a route, you can use a decorator to change the version.

CORS

CORS (Cross-Origin Resource Sharing) is a security feature in web browsers that controls how resources from one domain can be accessed by another. It works using HTTP headers, mainly Access-Control-Allow-Origin, to specify which domains are allowed to make requests. Simple requests don't need special checks, while complex ones require a preflight request to confirm permissions. CORS helps prevent unauthorized cross-site data access.

app.enableCors({
    exposedHeaders: ['Content-Disposition']
})

Documentation

SwaggerModule.addDocumentation(app)

Configurates the Swagger document and serves it on /api/docs

ApiContainer class

This class automatically starts the application and listens for requests on the given port.

It also exposes some health checks and implements a shutdown hook.

Running locally

pnpm start:dev api