Dart - api.route.delete()

Register a handler for HTTP DELETE requests to the route.

import 'package:nitric_sdk/nitric.dart';

final customersRoute = Nitric.api("public").route("/customers");

customersRoute.delete((ctx) async {
  // construct response for the DELETE: /customers request...
  final responseBody = {};
  ctx.res.json(responseBody);

  return ctx;
});

Parameters

Name
handler
Required
Required
Type
HttpHandler
Description
The middleware service to use as the handler for HTTP requests.
Name
security
Optional
Optional
Type
List<OidcOptions>
Description
Security rules to apply with scopes to the entire API.

Examples

Register a handler for DELETE requests

import 'package:nitric_sdk/nitric.dart';

final customersRoute = Nitric.api("public").route("/customers");

customersRoute.delete((ctx) async {
  // construct response for the DELETE: /customers request...
  final responseBody = {};
  ctx.res.json(responseBody);

  return ctx;
});

Access the request body

The DELETE request body is accessible from the ctx.req object.

import 'package:nitric_sdk/nitric.dart';

final customersRoute = Nitric.api("public").route("/customers");

customersRoute.delete((ctx) async {
  final customerData = ctx.req.json();
  // parase, validate and store the request payload if it's available

  return ctx;
});

Edit this page on GitHub

Last updated on Oct 15, 2024