Cookies

Read a cookie the client sent with @Cookie(name). Set cookies on the response through SetCookies, which becomes one Set-Cookie header per cookie.

Minimal example#

import 'package:revali_router/revali_router.dart';

@Controller('session')
class SessionController {
  const SessionController();

  @Post()
  void login(SetCookies cookies) {
    cookies['session'] = 'abc123';
    cookies.maxAge = const Duration(days: 7);
  }

  @Get()
  String current(@Cookie('session') String? session) => session ?? 'none';
}

curl -i -X POST http://localhost:8080/api/session
# set-cookie: session=abc123; Secure; HttpOnly; SameSite=Lax; Path=/; Max-Age=604800

curl http://localhost:8080/api/session -H 'Cookie: session=abc123'
# {"data":"abc123"}

Reading cookies#

Setting cookies#

SetCookies is available as an implied parameter in endpoints and lifecycle components, and as response.headers.setCookies.

class EnsureVisitorId implements LifecycleComponent {
  const EnsureVisitorId();

  MiddlewareResult assign(Request request, SetCookies cookies) {
    if (request.headers.cookies['visitor'] == null) {
      cookies['visitor'] = generateVisitorId();
    }

    return const MiddlewareResult.next();
  }
}

To delete a cookie in the browser, set it again with Max-Age 0:

cookies['session'] = '';
cookies.maxAge = Duration.zero;

Related: Response headers · Binding