Python - api.all()

Register an API route that handles all HTTP verbs on that route.

from nitric.resources import api
from nitric.application import Nitric

publicApi = api("public")

@publicApi.all("/customer/:customerId")
async def customer_update(ctx):
    id = ctx.req.params.customerId

    ctx.res.body = f"Updating customer {id}"

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 examples.
Name
options
Required
Required
Type
MethodOptions
Description
Options to configure the route such as security options.

Examples

Register a handler for all HTTP verbs

from nitric.resources import api
from nitric.application import Nitric

publicApi = api("public")

@publicApi.all("/customer/:customerId")
async def hello_world(ctx):
    id = ctx.req.params.customerId

    ctx.res.body = f"Updating customer {id}"

Nitric.run()

Edit this page on GitHub

Last updated on May 9, 2025