APIs
Node.js - 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()
import { api } from '@nitric/sdk';
const PARAM_ID = 'customerId';
api('public').put(`/customers/:${PARAM_ID}`, (ctx) => {
// construct response for the PUT: /customers request...
const responseBody = {};
ctx.res.json(responseBody);
});
Parameters
match required string
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
middleware required HttpMiddleware
| HttpMiddleware[]
One or more middleware functions to use as the handler for HTTP requests. Handlers can be sync or async
opts optional object
Additional options when creating method.
Properties |
---|
security optional map<string, string[]> Security rules to apply with scopes to the entire API. Keys must match a securityDefinition |
Examples
Register a handler for PUT requests
import { api } from '@nitric/sdk';
const PARAM_ID = 'customerId';
api('public').put(`/customers/:${PARAM_ID}`, (ctx) => {
const id = ctx.req.params[PARAM_ID];
// handle the PUT request...
const responseBody = {};
ctx.res.json(responseBody);
});
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.
import { api } from '@nitric/sdk';
import { validate } from '../middleware';
const PARAM_ID = 'customerId';
const putCustomer = (ctx) => {
const id = ctx.req.params[PARAM_ID];
// handle the PUT request...
const responseBody = {};
ctx.res.json(responseBody);
};
api('public').put(`/customers/:${PARAM_ID}`, [validate, putCustomer]);
Access the request body
The PUT request body is accessible from the ctx.req
object.
import { api } from '@nitric/sdk';
api('public').put(`/customers`, (ctx) => {
const customerData = ctx.req.data;
// parse, validate and store the request payload...
});