The C# .NET SDK currently only supports legacy versions of Nitric prior to v1. This version is maintained for compatibility with existing projects and not recommended for new projects. New projects should be started using a supported SDK (presented automatically using the `nitric new` command) orget in touch to request an update to the latest version.

.NET - Api.Route.All()

using Nitric.Sdk;

var route = Nitric.Api("main").Route("/customers");

route.All(context => {
    // Construct a response for all incoming HTTP requests
    var responseBody = new Dictionary<string, string>();
    context.Res.Json(responseBody);

    return context;
});

Nitric.Run();

Parameters

Name
...middleware
Required
Required
Type
Middleware<HttpContext> or Func<HttpContext, HttpContext>
Description
One or more middleware functions to use as the handler for HTTP requests. Handlers can be sync or async.

Notes

When using the All() method to register a single function as the handler for all HTTP methods, none of the other methods should be defined on that route.

using Nitric.Sdk;

var route = Nitric.Api("main").Route("/customers");

route.All(context => {
  /* handle all requests */
});

// Don't call `Get()`, `Post()`, etc., they're already handled by `all()`
route.Get(context => {
  // This handler won't work
})

Nitric.Run();

Examples

Register a method handler function

using Nitric.Sdk;

var route = Nitric.Api("main").Route("/customers");

route.All(context => {
    // Construct a response for all incoming HTTP requests
    var responseBody = new Dictionary<string, string>();
    context.Res.Json(responseBody);

    return context;
});

Nitric.Run();

Chain functions as a single method handler

When multiple functions are provided they will be called as a chain. If one succeeds, it will move on to the next. This allows middleware to be composed into more complex handlers.

var route = Nitric.Api("main").Route("/customers");

route.All((context, next) => {
    var user = context.Req.PathParams["userId"];

    // Validate the user identity
    if (user != "1234")
    {
        context.Res.Text($"User {user} is unauthorised");
        context.Res.Status = 403;

        // Return prematurely to end the middleware chain.
        return context;
    }

    // Call next to continue the middleware chain.
    return next(context);
  }, (context, next) => {
    var user = context.Req.PathParams["userId"];

    context.Res.Text($"Handling {user}");

    return next(context);
  }
);

Nitric.Run();

Access the request body

For methods that include a request body, such as POST and PUT, you can access the body from the ctx.req object.

using Nitric.Sdk;

var api = Nitric.Api("main").Route("/customers");

route.All(context => {
  var body = context.Req.Json<Dictionary<string, string>>();
  // parse, validate and store the request payload...
});

Nitric.Run();