Dart - api.route.post()

Register a handler for HTTP POST requests to the route.

import 'package:nitric_sdk/nitric.dart';
final customersRoute = Nitric.api("public").route("/customers");
customersRoute.post((ctx) async {
// construct response for the POST: /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 POST requests

import 'package:nitric_sdk/nitric.dart';
final customersRoute = Nitric.api("public").route("/customers");
customersRoute.post((ctx) async {
// construct response for the POST: /customers request...
final responseBody = {};
ctx.res.json(responseBody);
return ctx;
});

Access the request body

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

import 'package:nitric_sdk/nitric.dart';
final customersRoute = Nitric.api("public").route("/customers");
customersRoute.post((ctx) async {
final customerData = ctx.req.json();
// parase, validate and store the request payload if it's available
return ctx;
});
Last updated on Oct 16, 2024