Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(middlewares): add versioning integration docs #2523

Merged
merged 2 commits into from
Nov 8, 2022
Merged

docs(middlewares): add versioning integration docs #2523

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fb076a
docs(middlewares): add versioning integration docs
thiagomini Nov 7, 2022
9761c1f
docs(techniques): move middleware section
thiagomini Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions content/middlewares.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,33 @@ export class AppModule {

> info **Hint** The `apply()` method may either take a single middleware, or multiple arguments to specify <a href="/middleware#multiple-middleware">multiple middlewares</a>.

#### Middleware versioning
thiagomini marked this conversation as resolved.
Show resolved Hide resolved

The `MiddlewareConsumer` can also use the [versioning](https://docs.nestjs.com/techniques/versioning) metadata to configure the middleware for a specific route's version.

```typescript
@@filename(app.module)
import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
import { LoggerMiddleware } from './common/middleware/logger.middleware';
import { CatsModule } from './cats/cats.module';
import { CatsController } from './cats/cats.controller';

@Module({
imports: [CatsModule],
})
export class AppModule implements NestModule {
configure(consumer: MiddlewareConsumer) {
consumer
.apply(LoggerMiddleware)
.forRoutes({ path: 'cats', method: RequestMethod.GET, version: '2' );
}
}
```

With the code above, the `LoggerMiddleware` will only be applied to the version '2' of `/cats` endpoint.

> info **Notice** Middlewares work with any versioning type described in the linked section: `URI`, `Header`, `Media Type` or `Custom`.

#### Excluding routes

At times we want to **exclude** certain routes from having the middleware applied. We can easily exclude certain routes with the `exclude()` method. This method can take a single string, multiple strings, or a `RouteInfo` object identifying routes to be excluded, as shown below:
Expand Down