Nitric logo

APIs

api()

Creates a new HTTP API.

from nitric.resources import api

publicApi = api("public")

Parameters


name required string

The unique name of this API within the app. Subsequent calls to api with the same name will return the same object.


options optional object

Additional options when creating the API.

Properties
path optional string base path for all routes in the API.
middleware optional List[Middleware] Middleware to apply to all routes and methods of the API.
securityDefinitions optional dict[str, SecurityDefiniton] Security definitions defined by this API.
security optional dict[str, List[str]] Security rules to apply with scopes to the entire API. Keys must match a securityDefinition

SecurityDefinition

A SecurityDefinition object is one of the following:

JWTSecurityDefinition

Properties
issuer string the issuer for the JWT tokens e.g. https://account.region.auth0.com.
audiences string[] the aud that will be applied to JWT tokens from the issuer.

Notes

The middleware property on the options param is useful for applying universal middleware such as CORS headers, across an entire API from a single place.

Examples

Create an API

from nitric.resources import api

publicApi = api("public")

Create an API with universal middleware

from nitric.resources import api, ApiOptions
from myapp.middleware import auth

publicApi = api("public", ApiOptions(middleware=[auth]))

Create an API with a base path

If you need to put all the routes in your api below a shared base path, you can do that with the path option. In this example we ensure all routes start with /api/v1/ before the route specific path.

from nitric.resources import api, ApiOptions

publicApi = api("public", ApiOptions(path="/api/v1/"))

Apply JWT authentication to an API

from nitric.resources import api, ApiOptions

publicApi = api("public", ApiOptions(
    security_definitions={
        "user": JwtSecurityDefinition(
            issuer: "https://example-issuer.com"
            audiences: ['YOUR-AUDIENCES']
        )
    },
    security={
        "user": []
    }
))
Previous
Overview & Installation