Skip to content
FlagSwiftDocs

Integrate with NestJS

A module, a service and a route guard.

Before you start#

  • A server key (fs_srv_…) from the API Keys page of your console. See API keys for how keys differ.
  • The address of your FlagSwift server, for example https://flags.example.com.
  • A flag to read. Create one in the console and turn it on in an environment.

Keep the key on the server

Store the key in your secrets manager or an environment variable. Never commit it and never send it to a browser.

Your server#

Enter your server address and, if your key covers every environment of the project, the environment to read. The examples below fill in as you type. Nothing is sent anywhere: the values stay in this browser.

Set up#

  1. Environment

    bash
    FLAGSWIFT_URL=https://flags.example.com
    FLAGSWIFT_SERVER_KEY=fs_srv_...   # private; from the API Keys page
  2. Install

    bash
    npm install @flagswift/nestjs @flagswift/node
  3. Set up

    ts
    import { Module } from "@nestjs/common";
    import { FlagSwiftModule } from "@flagswift/nestjs";
    
    @Module({
      imports: [
        FlagSwiftModule.forRoot({
          apiKey: process.env.FLAGSWIFT_SERVER_KEY!,
          baseUrl: process.env.FLAGSWIFT_URL!,
          fallbacks: { "new-billing": false },
        }),
      ],
    })
    export class AppModule {}
  4. Use

    ts
    import { Controller, Get, Post, Req } from "@nestjs/common";
    import { FlagSwiftService, RequireFlag } from "@flagswift/nestjs";
    
    @Controller("invoices")
    export class InvoicesController {
      constructor(private readonly flags: FlagSwiftService) {}
    
      @Get()
      list(@Req() req) {
        return this.flags.isEnabledForRequest("fast-invoice-list", req) ? this.fast() : this.slow();
      }
    
      @RequireFlag("new-billing") // 404 unless the flag is ON for this user
      @Post("v2")
      create() {}
    }

Verify it works#

Before you run your app, check the key, the address and the environment with one request. A server key downloads the configuration your app will evaluate locally.

bash
curl -s "https://flags.example.com/api/v1/evaluation/server?mode=config" \
  -H "Authorization: Bearer $FLAGSWIFT_SERVER_KEY"

A 200 response with your flags means everything is wired up. If it fails, Troubleshooting lists the usual causes.

Next steps#