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.Put()

Register an API route and set a specific HTTP PUT handler on that route.

This method is a convenient short version of api().route().put()

using Nitric.Sdk;

var api = Nitric.Api("main");

api.Put("/hello/:name", context => {
  var name = context.Req.PathParams.get("name");

  context.Res.Text($"Updating {name}!");

  return context;
});

Nitric.Run();

Parameters

  • Name
    match
    Required
    Required
    Type
    string
    Description

    The path matcher to use for the route. Matchers accept path parameters in the form of a colon prefixed string. The string provided will be used as that path parameter's name when calling middleware and handlers. See create a route with path params

  • 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.

Examples

Register a handler for PUT requests

using Nitric.Sdk;

var api = Nitric.Api("main");

api.Put("/hello/:name", context => {
  var name = context.Req.PathParams.get("name");

  context.Res.Text($"Updating {name}!");

  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.

using Nitric.Sdk;

var api = Nitric.Api("main");

api.Put("/hello/:userId",
  (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($"Updating {user}");

    return next(context);
  }
);

Nitric.Run();

Access the request body

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

using Nitric.Sdk;

var api = Nitric.Api("main");

api.Put("/hello/:name", context => {
  var body = context.Req.Json<Dictionary<string, string>>();
  // parse, validate and store the request payload...
});

Nitric.Run();