Skip to content

# NinjaAPI

Ninja API

Source code in `ninja/main.py`

     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651

    class NinjaAPI:
        """
        Ninja API
        """

        def __init__(
            self,
            *,
            title: str = "NinjaAPI",
            version: str = "1.0.0",
            description: str = "",
            openapi_url: Optional[str] = "/openapi.json",
            docs: DocsBase = Swagger(),
            docs_url: Optional[str] = "/docs",
            docs_decorator: Optional[Callable[[TCallable], TCallable]] = None,
            servers: Optional[List[DictStrAny]] = None,
            urls_namespace: Optional[str] = None,
            auth: Optional[Union[Sequence[Callable], Callable, NOT_SET_TYPE]] = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            renderer: Optional[BaseRenderer] = None,
            parser: Optional[Parser] = None,
            default_router: Optional[Router] = None,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ):
            """
            Args:
                title: A title for the api.
                description: A description for the api.
                version: The API version.
                urls_namespace: The Django URL namespace for the API. If not provided, the namespace will be ``"api-" + self.version``.
                openapi_url: The relative URL to serve the openAPI spec.
                openapi_extra: Additional attributes for the openAPI spec.
                docs_url: The relative URL to serve the API docs.
                servers: List of target hosts used in openAPI spec.
                auth (Callable | Sequence[Callable] | NOT_SET | None): Authentication class
                renderer: Default response renderer
                parser: Default request parser
            """
            self.title = title
            self.version = version
            self.description = description
            self.openapi_url = openapi_url
            self.docs = docs
            self.docs_url = docs_url
            self.docs_decorator = docs_decorator
            self.servers = servers or []
            self.urls_namespace = urls_namespace or f"api-{self.version}"
            self.renderer = renderer or JSONRenderer()
            self.parser = parser or Parser()
            self.openapi_extra = openapi_extra or {}

            self._exception_handlers: Dict[Exc, ExcHandler] = {}
            self.set_default_exception_handlers()

            self.auth: Optional[Union[Sequence[Callable], NOT_SET_TYPE]]

            if callable(auth):
                self.auth = [auth]
            else:
                self.auth = auth

            self.throttle = throttle

            # Top-level router registrations (new architecture)
            # Stores (prefix, router, auth, throttle, tags, url_name_prefix) for each add_router call
            self._router_registrations: List[
                Tuple[str, Router, Any, Any, Optional[List[str]], Optional[str]]
            ] = []
            self._bound_routers_cache: Optional[List[BoundRouter]] = None

            # Backward compat: keep _routers list populated
            self._routers: List[Tuple[str, Router]] = []

            self.default_router = default_router or Router()
            self.add_router("", self.default_router)

        def get(
            self,
            path: str,
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            response: Any = NOT_SET,
            operation_id: Optional[str] = None,
            summary: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[List[str]] = None,
            deprecated: Optional[bool] = None,
            by_alias: Optional[bool] = None,
            exclude_unset: Optional[bool] = None,
            exclude_defaults: Optional[bool] = None,
            exclude_none: Optional[bool] = None,
            url_name: Optional[str] = None,
            include_in_schema: bool = True,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ) -> Callable[[TCallable], TCallable]:
            """
            `GET` operation. See <a href="../operations-parameters">operations
            parameters</a> reference.
            """
            return self.default_router.get(
                path,
                auth=auth is NOT_SET and self.auth or auth,
                throttle=throttle is NOT_SET and self.throttle or throttle,
                response=response,
                operation_id=operation_id,
                summary=summary,
                description=description,
                tags=tags,
                deprecated=deprecated,
                by_alias=by_alias,
                exclude_unset=exclude_unset,
                exclude_defaults=exclude_defaults,
                exclude_none=exclude_none,
                url_name=url_name,
                include_in_schema=include_in_schema,
                openapi_extra=openapi_extra,
            )

        def post(
            self,
            path: str,
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            response: Any = NOT_SET,
            operation_id: Optional[str] = None,
            summary: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[List[str]] = None,
            deprecated: Optional[bool] = None,
            by_alias: Optional[bool] = None,
            exclude_unset: Optional[bool] = None,
            exclude_defaults: Optional[bool] = None,
            exclude_none: Optional[bool] = None,
            url_name: Optional[str] = None,
            include_in_schema: bool = True,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ) -> Callable[[TCallable], TCallable]:
            """
            `POST` operation. See <a href="../operations-parameters">operations
            parameters</a> reference.
            """
            return self.default_router.post(
                path,
                auth=auth is NOT_SET and self.auth or auth,
                throttle=throttle is NOT_SET and self.throttle or throttle,
                response=response,
                operation_id=operation_id,
                summary=summary,
                description=description,
                tags=tags,
                deprecated=deprecated,
                by_alias=by_alias,
                exclude_unset=exclude_unset,
                exclude_defaults=exclude_defaults,
                exclude_none=exclude_none,
                url_name=url_name,
                include_in_schema=include_in_schema,
                openapi_extra=openapi_extra,
            )

        def delete(
            self,
            path: str,
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            response: Any = NOT_SET,
            operation_id: Optional[str] = None,
            summary: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[List[str]] = None,
            deprecated: Optional[bool] = None,
            by_alias: Optional[bool] = None,
            exclude_unset: Optional[bool] = None,
            exclude_defaults: Optional[bool] = None,
            exclude_none: Optional[bool] = None,
            url_name: Optional[str] = None,
            include_in_schema: bool = True,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ) -> Callable[[TCallable], TCallable]:
            """
            `DELETE` operation. See <a href="../operations-parameters">operations
            parameters</a> reference.
            """
            return self.default_router.delete(
                path,
                auth=auth is NOT_SET and self.auth or auth,
                throttle=throttle is NOT_SET and self.throttle or throttle,
                response=response,
                operation_id=operation_id,
                summary=summary,
                description=description,
                tags=tags,
                deprecated=deprecated,
                by_alias=by_alias,
                exclude_unset=exclude_unset,
                exclude_defaults=exclude_defaults,
                exclude_none=exclude_none,
                url_name=url_name,
                include_in_schema=include_in_schema,
                openapi_extra=openapi_extra,
            )

        def patch(
            self,
            path: str,
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            response: Any = NOT_SET,
            operation_id: Optional[str] = None,
            summary: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[List[str]] = None,
            deprecated: Optional[bool] = None,
            by_alias: Optional[bool] = None,
            exclude_unset: Optional[bool] = None,
            exclude_defaults: Optional[bool] = None,
            exclude_none: Optional[bool] = None,
            url_name: Optional[str] = None,
            include_in_schema: bool = True,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ) -> Callable[[TCallable], TCallable]:
            """
            `PATCH` operation. See <a href="../operations-parameters">operations
            parameters</a> reference.
            """
            return self.default_router.patch(
                path,
                auth=auth is NOT_SET and self.auth or auth,
                throttle=throttle is NOT_SET and self.throttle or throttle,
                response=response,
                operation_id=operation_id,
                summary=summary,
                description=description,
                tags=tags,
                deprecated=deprecated,
                by_alias=by_alias,
                exclude_unset=exclude_unset,
                exclude_defaults=exclude_defaults,
                exclude_none=exclude_none,
                url_name=url_name,
                include_in_schema=include_in_schema,
                openapi_extra=openapi_extra,
            )

        def put(
            self,
            path: str,
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            response: Any = NOT_SET,
            operation_id: Optional[str] = None,
            summary: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[List[str]] = None,
            deprecated: Optional[bool] = None,
            by_alias: Optional[bool] = None,
            exclude_unset: Optional[bool] = None,
            exclude_defaults: Optional[bool] = None,
            exclude_none: Optional[bool] = None,
            url_name: Optional[str] = None,
            include_in_schema: bool = True,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ) -> Callable[[TCallable], TCallable]:
            """
            `PUT` operation. See <a href="../operations-parameters">operations
            parameters</a> reference.
            """
            return self.default_router.put(
                path,
                auth=auth is NOT_SET and self.auth or auth,
                throttle=throttle is NOT_SET and self.throttle or throttle,
                response=response,
                operation_id=operation_id,
                summary=summary,
                description=description,
                tags=tags,
                deprecated=deprecated,
                by_alias=by_alias,
                exclude_unset=exclude_unset,
                exclude_defaults=exclude_defaults,
                exclude_none=exclude_none,
                url_name=url_name,
                include_in_schema=include_in_schema,
                openapi_extra=openapi_extra,
            )

        def api_operation(
            self,
            methods: List[str],
            path: str,
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            response: Any = NOT_SET,
            operation_id: Optional[str] = None,
            summary: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[List[str]] = None,
            deprecated: Optional[bool] = None,
            by_alias: Optional[bool] = None,
            exclude_unset: Optional[bool] = None,
            exclude_defaults: Optional[bool] = None,
            exclude_none: Optional[bool] = None,
            url_name: Optional[str] = None,
            include_in_schema: bool = True,
            openapi_extra: Optional[Dict[str, Any]] = None,
        ) -> Callable[[TCallable], TCallable]:
            return self.default_router.api_operation(
                methods,
                path,
                auth=auth is NOT_SET and self.auth or auth,
                throttle=throttle is NOT_SET and self.throttle or throttle,
                response=response,
                operation_id=operation_id,
                summary=summary,
                description=description,
                tags=tags,
                deprecated=deprecated,
                by_alias=by_alias,
                exclude_unset=exclude_unset,
                exclude_defaults=exclude_defaults,
                exclude_none=exclude_none,
                url_name=url_name,
                include_in_schema=include_in_schema,
                openapi_extra=openapi_extra,
            )

        def add_decorator(
            self,
            decorator: Callable,
            mode: DecoratorMode = "operation",
        ) -> None:
            """
            Add a decorator to be applied to all operations in the entire API.

            Args:
                decorator: The decorator function to apply
                mode: "operation" (default) applies after validation,
                      "view" applies before validation
            """
            # Store decorator on default router - will be inherited by all routers during build
            self.default_router.add_decorator(decorator, mode)

        def add_router(
            self,
            prefix: str,
            router: Union[Router, str],
            *,
            auth: Any = NOT_SET,
            throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
            tags: Optional[List[str]] = None,
            url_name_prefix: Optional[str] = None,
            parent_router: Optional[Router] = None,
        ) -> None:
            """
            Add a router to this API.

            Args:
                prefix: URL prefix for all routes in the router
                router: Router instance or import path string
                auth: Authentication override for this router
                throttle: Throttle override for this router
                tags: Tags override for this router
                url_name_prefix: Prefix for URL names (required when mounting same router multiple times)
                parent_router: Internal use - parent router for nested routers
            """
            # Prevent adding routers after URLs have been generated
            if self._bound_routers_cache is not None:
                raise ConfigError(
                    "Cannot add routers after URLs have been generated. "
                    "Add all routers before accessing api.urls"
                )

            if isinstance(router, str):
                router = import_string(router)
                assert isinstance(router, Router)

            # Check for duplicate router template - require url_name_prefix
            existing_templates = {reg[1] for reg in self._router_registrations}
            if router in existing_templates and url_name_prefix is None:
                raise ConfigError(
                    "Router is already mounted to this API. When mounting the same router "
                    "multiple times, you must provide unique url_name_prefix for each mount."
                )

            # Store registration for later processing during URL generation
            # This allows child routers to be added after add_router() is called
            self._router_registrations.append((
                prefix,
                router,
                auth,
                throttle,
                tags,
                url_name_prefix,
            ))

            # Backward compat: keep _routers list updated (just the top-level router)
            self._routers.append((prefix, router))

        @property
        def urls(self) -> Tuple[List[Union[URLResolver, URLPattern]], str, str]:
            """
            str: URL configuration

            Returns:

                Django URL configuration
            """
            self._validate()
            return (
                self._get_urls(),
                "ninja",
                self.urls_namespace.split(":")[-1],
                # ^ if api included into nested urls, we only care about last bit here
            )

        def _get_bound_routers(self) -> List[BoundRouter]:
            """Get or create bound router instances."""
            if self._bound_routers_cache is None:
                # Build mounts from registrations (delayed to capture all child routers)
                all_mounts: List[RouterMount] = []

                for (
                    prefix,
                    router,
                    auth,
                    throttle,
                    tags,
                    url_name_prefix,
                ) in self._router_registrations:
                    # Get API-level decorators from default router
                    api_decorators = (
                        self.default_router._decorators
                        if router is not self.default_router
                        else []
                    )

                    # Build mount configurations (non-mutating)
                    # Pass auth/throttle/tags so they can be inherited by children
                    mounts = router.build_routers(
                        prefix,
                        api_decorators,
                        inherited_auth=auth,
                        inherited_throttle=throttle,
                        inherited_tags=tags,
                    )

                    # Apply mount-level overrides to the first (parent) mount
                    # build_routers() always returns at least one mount (the router itself)
                    first_mount = mounts[0]
                    if auth is not NOT_SET:
                        first_mount.auth = auth
                    if throttle is not NOT_SET:
                        first_mount.throttle = throttle
                    if tags is not None:
                        first_mount.tags = tags

                    # Apply url_name_prefix to all mounts
                    if url_name_prefix is not None:
                        for mount in mounts:
                            mount.url_name_prefix = url_name_prefix

                    all_mounts.extend(mounts)

                # Create bound routers from mounts
                self._bound_routers_cache = [
                    BoundRouter(mount, self) for mount in all_mounts
                ]

                # Freeze all templates after binding
                for mount in all_mounts:
                    mount.template._freeze()

                # Update _routers for backward compat (include all nested routers)
                self._routers = [(m.prefix, m.template) for m in all_mounts]

            return self._bound_routers_cache

        def _get_urls(self) -> List[Union[URLResolver, URLPattern]]:
            result = get_openapi_urls(self)

            for bound_router in self._get_bound_routers():
                result.extend(bound_router.urls_paths(bound_router.prefix))

            result.append(get_root_url(self))
            return result

        def get_root_path(self, path_params: DictStrAny) -> str:
            name = f"{self.urls_namespace}:api-root"
            return reverse(name, kwargs=path_params)

        def create_response(
            self,
            request: HttpRequest,
            data: Any,
            *,
            status: Optional[int] = None,
            temporal_response: Optional[HttpResponse] = None,
        ) -> HttpResponse:
            if temporal_response:
                status = temporal_response.status_code
            assert status

            content = self.renderer.render(request, data, response_status=status)

            if temporal_response:
                response = temporal_response
                response.content = content
            else:
                response = HttpResponse(
                    content, status=status, content_type=self.get_content_type()
                )

            return response

        def create_temporal_response(self, request: HttpRequest) -> HttpResponse:
            return HttpResponse("", content_type=self.get_content_type())

        def get_content_type(self) -> str:
            return f"{self.renderer.media_type}; charset={self.renderer.charset}"

        def get_openapi_schema(
            self,
            *,
            path_prefix: Optional[str] = None,
            path_params: Optional[DictStrAny] = None,
        ) -> OpenAPISchema:
            if path_prefix is None:
                path_prefix = self.get_root_path(path_params or {})
            return get_schema(api=self, path_prefix=path_prefix)

        def get_openapi_operation_id(self, operation: "Operation") -> str:
            name = operation.view_func.__name__
            module = operation.view_func.__module__
            return (module + "_" + name).replace(".", "_")

        def get_operation_url_name(self, operation: "Operation", router: Router) -> str:
            """
            Get the default URL name to use for an operation if it wasn't
            explicitly provided.
            """
            return operation.view_func.__name__

        def add_exception_handler(
            self, exc_class: Type[_E], handler: ExcHandler[_E]
        ) -> None:
            assert issubclass(exc_class, Exception)
            self._exception_handlers[exc_class] = handler

        def exception_handler(
            self, exc_class: Type[Exception]
        ) -> Callable[[TCallable], TCallable]:
            def decorator(func: TCallable) -> TCallable:
                self.add_exception_handler(exc_class, func)
                return func

            return decorator

        def set_default_exception_handlers(self) -> None:
            set_default_exc_handlers(self)

        def on_exception(self, request: HttpRequest, exc: Exc[_E]) -> HttpResponse:
            handler = self._lookup_exception_handler(exc)
            if handler is None:
                raise exc
            return handler(request, exc)

        def validation_error_from_error_contexts(
            self, error_contexts: List[ValidationErrorContext]
        ) -> ValidationError:
            errors: List[Dict[str, Any]] = []
            for context in error_contexts:
                model = context.model
                e = context.pydantic_validation_error
                for i in e.errors(include_url=False):
                    i["loc"] = (
                        model.__ninja_param_source__,
                    ) + model.__ninja_flatten_map_reverse__.get(i["loc"], i["loc"])
                    # removing pydantic hints
                    del i["input"]  # type: ignore
                    if (
                        "ctx" in i
                        and "error" in i["ctx"]
                        and isinstance(i["ctx"]["error"], Exception)
                    ):
                        i["ctx"]["error"] = str(i["ctx"]["error"])
                    errors.append(dict(i))
            return ValidationError(errors)

        def _lookup_exception_handler(self, exc: Exc[_E]) -> Optional[ExcHandler[_E]]:
            for cls in type(exc).__mro__:
                if cls in self._exception_handlers:
                    return self._exception_handlers[cls]

            return None

        def _validate(self) -> None:
            # Registry check no longer needed - routers are independent templates
            # and can be reused across multiple APIs without conflicts
            pass

## `urls` `property`

str: URL configuration

Returns:

    Django URL configuration

## `__init__(*, title='NinjaAPI', version='1.0.0', description='', openapi_url='/openapi.json', docs=Swagger(), docs_url='/docs', docs_decorator=None, servers=None, urls_namespace=None, auth=NOT_SET, throttle=NOT_SET, renderer=None, parser=None, default_router=None, openapi_extra=None)`

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`title` | `str` | A title for the api. | `'NinjaAPI'`
`description` | `str` | A description for the api. | `''`
`version` | `str` | The API version. | `'1.0.0'`
`urls_namespace` | `Optional[str]` | The Django URL namespace for the API. If not provided, the namespace will be `"api-" + self.version`. | `None`
`openapi_url` | `Optional[str]` | The relative URL to serve the openAPI spec. | `'/openapi.json'`
`openapi_extra` | `Optional[Dict[str, Any]]` | Additional attributes for the openAPI spec. | `None`
`docs_url` | `Optional[str]` | The relative URL to serve the API docs. | `'/docs'`
`servers` | `Optional[List[DictStrAny]]` | List of target hosts used in openAPI spec. | `None`
`auth` | `Callable | Sequence[Callable] | NOT_SET | None` | Authentication class | `NOT_SET`
`renderer` | `Optional[BaseRenderer]` | Default response renderer | `None`
`parser` | `Optional[Parser]` | Default request parser | `None`

Source code in `ninja/main.py`

     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121

    def __init__(
        self,
        *,
        title: str = "NinjaAPI",
        version: str = "1.0.0",
        description: str = "",
        openapi_url: Optional[str] = "/openapi.json",
        docs: DocsBase = Swagger(),
        docs_url: Optional[str] = "/docs",
        docs_decorator: Optional[Callable[[TCallable], TCallable]] = None,
        servers: Optional[List[DictStrAny]] = None,
        urls_namespace: Optional[str] = None,
        auth: Optional[Union[Sequence[Callable], Callable, NOT_SET_TYPE]] = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        renderer: Optional[BaseRenderer] = None,
        parser: Optional[Parser] = None,
        default_router: Optional[Router] = None,
        openapi_extra: Optional[Dict[str, Any]] = None,
    ):
        """
        Args:
            title: A title for the api.
            description: A description for the api.
            version: The API version.
            urls_namespace: The Django URL namespace for the API. If not provided, the namespace will be ``"api-" + self.version``.
            openapi_url: The relative URL to serve the openAPI spec.
            openapi_extra: Additional attributes for the openAPI spec.
            docs_url: The relative URL to serve the API docs.
            servers: List of target hosts used in openAPI spec.
            auth (Callable | Sequence[Callable] | NOT_SET | None): Authentication class
            renderer: Default response renderer
            parser: Default request parser
        """
        self.title = title
        self.version = version
        self.description = description
        self.openapi_url = openapi_url
        self.docs = docs
        self.docs_url = docs_url
        self.docs_decorator = docs_decorator
        self.servers = servers or []
        self.urls_namespace = urls_namespace or f"api-{self.version}"
        self.renderer = renderer or JSONRenderer()
        self.parser = parser or Parser()
        self.openapi_extra = openapi_extra or {}

        self._exception_handlers: Dict[Exc, ExcHandler] = {}
        self.set_default_exception_handlers()

        self.auth: Optional[Union[Sequence[Callable], NOT_SET_TYPE]]

        if callable(auth):
            self.auth = [auth]
        else:
            self.auth = auth

        self.throttle = throttle

        # Top-level router registrations (new architecture)
        # Stores (prefix, router, auth, throttle, tags, url_name_prefix) for each add_router call
        self._router_registrations: List[
            Tuple[str, Router, Any, Any, Optional[List[str]], Optional[str]]
        ] = []
        self._bound_routers_cache: Optional[List[BoundRouter]] = None

        # Backward compat: keep _routers list populated
        self._routers: List[Tuple[str, Router]] = []

        self.default_router = default_router or Router()
        self.add_router("", self.default_router)

## `add_decorator(decorator, mode='operation')`

Add a decorator to be applied to all operations in the entire API.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`decorator` | `Callable` | The decorator function to apply | required
`mode` | `DecoratorMode` | "operation" (default) applies after validation, "view" applies before validation | `'operation'`

Source code in `ninja/main.py`

    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393

    def add_decorator(
        self,
        decorator: Callable,
        mode: DecoratorMode = "operation",
    ) -> None:
        """
        Add a decorator to be applied to all operations in the entire API.

        Args:
            decorator: The decorator function to apply
            mode: "operation" (default) applies after validation,
                  "view" applies before validation
        """
        # Store decorator on default router - will be inherited by all routers during build
        self.default_router.add_decorator(decorator, mode)

## `add_router(prefix, router, *, auth=NOT_SET, throttle=NOT_SET, tags=None, url_name_prefix=None, parent_router=None)`

Add a router to this API.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`prefix` | `str` | URL prefix for all routes in the router | required
`router` | `Union[Router, str]` | Router instance or import path string | required
`auth` | `Any` | Authentication override for this router | `NOT_SET`
`throttle` | `Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE]` | Throttle override for this router | `NOT_SET`
`tags` | `Optional[List[str]]` | Tags override for this router | `None`
`url_name_prefix` | `Optional[str]` | Prefix for URL names (required when mounting same router multiple times) | `None`
`parent_router` | `Optional[Router]` | Internal use - parent router for nested routers | `None`

Source code in `ninja/main.py`

    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449

    def add_router(
        self,
        prefix: str,
        router: Union[Router, str],
        *,
        auth: Any = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        tags: Optional[List[str]] = None,
        url_name_prefix: Optional[str] = None,
        parent_router: Optional[Router] = None,
    ) -> None:
        """
        Add a router to this API.

        Args:
            prefix: URL prefix for all routes in the router
            router: Router instance or import path string
            auth: Authentication override for this router
            throttle: Throttle override for this router
            tags: Tags override for this router
            url_name_prefix: Prefix for URL names (required when mounting same router multiple times)
            parent_router: Internal use - parent router for nested routers
        """
        # Prevent adding routers after URLs have been generated
        if self._bound_routers_cache is not None:
            raise ConfigError(
                "Cannot add routers after URLs have been generated. "
                "Add all routers before accessing api.urls"
            )

        if isinstance(router, str):
            router = import_string(router)
            assert isinstance(router, Router)

        # Check for duplicate router template - require url_name_prefix
        existing_templates = {reg[1] for reg in self._router_registrations}
        if router in existing_templates and url_name_prefix is None:
            raise ConfigError(
                "Router is already mounted to this API. When mounting the same router "
                "multiple times, you must provide unique url_name_prefix for each mount."
            )

        # Store registration for later processing during URL generation
        # This allows child routers to be added after add_router() is called
        self._router_registrations.append((
            prefix,
            router,
            auth,
            throttle,
            tags,
            url_name_prefix,
        ))

        # Backward compat: keep _routers list updated (just the top-level router)
        self._routers.append((prefix, router))

## `delete(path, *, auth=NOT_SET, throttle=NOT_SET, response=NOT_SET, operation_id=None, summary=None, description=None, tags=None, deprecated=None, by_alias=None, exclude_unset=None, exclude_defaults=None, exclude_none=None, url_name=None, include_in_schema=True, openapi_extra=None)`

`DELETE` operation. See operations parameters reference.

Source code in `ninja/main.py`

    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250

    def delete(
        self,
        path: str,
        *,
        auth: Any = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        response: Any = NOT_SET,
        operation_id: Optional[str] = None,
        summary: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        deprecated: Optional[bool] = None,
        by_alias: Optional[bool] = None,
        exclude_unset: Optional[bool] = None,
        exclude_defaults: Optional[bool] = None,
        exclude_none: Optional[bool] = None,
        url_name: Optional[str] = None,
        include_in_schema: bool = True,
        openapi_extra: Optional[Dict[str, Any]] = None,
    ) -> Callable[[TCallable], TCallable]:
        """
        `DELETE` operation. See <a href="../operations-parameters">operations
        parameters</a> reference.
        """
        return self.default_router.delete(
            path,
            auth=auth is NOT_SET and self.auth or auth,
            throttle=throttle is NOT_SET and self.throttle or throttle,
            response=response,
            operation_id=operation_id,
            summary=summary,
            description=description,
            tags=tags,
            deprecated=deprecated,
            by_alias=by_alias,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none,
            url_name=url_name,
            include_in_schema=include_in_schema,
            openapi_extra=openapi_extra,
        )

## `get(path, *, auth=NOT_SET, throttle=NOT_SET, response=NOT_SET, operation_id=None, summary=None, description=None, tags=None, deprecated=None, by_alias=None, exclude_unset=None, exclude_defaults=None, exclude_none=None, url_name=None, include_in_schema=True, openapi_extra=None)`

`GET` operation. See operations parameters reference.

Source code in `ninja/main.py`

    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164

    def get(
        self,
        path: str,
        *,
        auth: Any = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        response: Any = NOT_SET,
        operation_id: Optional[str] = None,
        summary: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        deprecated: Optional[bool] = None,
        by_alias: Optional[bool] = None,
        exclude_unset: Optional[bool] = None,
        exclude_defaults: Optional[bool] = None,
        exclude_none: Optional[bool] = None,
        url_name: Optional[str] = None,
        include_in_schema: bool = True,
        openapi_extra: Optional[Dict[str, Any]] = None,
    ) -> Callable[[TCallable], TCallable]:
        """
        `GET` operation. See <a href="../operations-parameters">operations
        parameters</a> reference.
        """
        return self.default_router.get(
            path,
            auth=auth is NOT_SET and self.auth or auth,
            throttle=throttle is NOT_SET and self.throttle or throttle,
            response=response,
            operation_id=operation_id,
            summary=summary,
            description=description,
            tags=tags,
            deprecated=deprecated,
            by_alias=by_alias,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none,
            url_name=url_name,
            include_in_schema=include_in_schema,
            openapi_extra=openapi_extra,
        )

## `get_operation_url_name(operation, router)`

Get the default URL name to use for an operation if it wasn't explicitly provided.

Source code in `ninja/main.py`

    588
    589
    590
    591
    592
    593

    def get_operation_url_name(self, operation: "Operation", router: Router) -> str:
        """
        Get the default URL name to use for an operation if it wasn't
        explicitly provided.
        """
        return operation.view_func.__name__

## `patch(path, *, auth=NOT_SET, throttle=NOT_SET, response=NOT_SET, operation_id=None, summary=None, description=None, tags=None, deprecated=None, by_alias=None, exclude_unset=None, exclude_defaults=None, exclude_none=None, url_name=None, include_in_schema=True, openapi_extra=None)`

`PATCH` operation. See operations parameters reference.

Source code in `ninja/main.py`

    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293

    def patch(
        self,
        path: str,
        *,
        auth: Any = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        response: Any = NOT_SET,
        operation_id: Optional[str] = None,
        summary: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        deprecated: Optional[bool] = None,
        by_alias: Optional[bool] = None,
        exclude_unset: Optional[bool] = None,
        exclude_defaults: Optional[bool] = None,
        exclude_none: Optional[bool] = None,
        url_name: Optional[str] = None,
        include_in_schema: bool = True,
        openapi_extra: Optional[Dict[str, Any]] = None,
    ) -> Callable[[TCallable], TCallable]:
        """
        `PATCH` operation. See <a href="../operations-parameters">operations
        parameters</a> reference.
        """
        return self.default_router.patch(
            path,
            auth=auth is NOT_SET and self.auth or auth,
            throttle=throttle is NOT_SET and self.throttle or throttle,
            response=response,
            operation_id=operation_id,
            summary=summary,
            description=description,
            tags=tags,
            deprecated=deprecated,
            by_alias=by_alias,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none,
            url_name=url_name,
            include_in_schema=include_in_schema,
            openapi_extra=openapi_extra,
        )

## `post(path, *, auth=NOT_SET, throttle=NOT_SET, response=NOT_SET, operation_id=None, summary=None, description=None, tags=None, deprecated=None, by_alias=None, exclude_unset=None, exclude_defaults=None, exclude_none=None, url_name=None, include_in_schema=True, openapi_extra=None)`

`POST` operation. See operations parameters reference.

Source code in `ninja/main.py`

    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207

    def post(
        self,
        path: str,
        *,
        auth: Any = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        response: Any = NOT_SET,
        operation_id: Optional[str] = None,
        summary: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        deprecated: Optional[bool] = None,
        by_alias: Optional[bool] = None,
        exclude_unset: Optional[bool] = None,
        exclude_defaults: Optional[bool] = None,
        exclude_none: Optional[bool] = None,
        url_name: Optional[str] = None,
        include_in_schema: bool = True,
        openapi_extra: Optional[Dict[str, Any]] = None,
    ) -> Callable[[TCallable], TCallable]:
        """
        `POST` operation. See <a href="../operations-parameters">operations
        parameters</a> reference.
        """
        return self.default_router.post(
            path,
            auth=auth is NOT_SET and self.auth or auth,
            throttle=throttle is NOT_SET and self.throttle or throttle,
            response=response,
            operation_id=operation_id,
            summary=summary,
            description=description,
            tags=tags,
            deprecated=deprecated,
            by_alias=by_alias,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none,
            url_name=url_name,
            include_in_schema=include_in_schema,
            openapi_extra=openapi_extra,
        )

## `put(path, *, auth=NOT_SET, throttle=NOT_SET, response=NOT_SET, operation_id=None, summary=None, description=None, tags=None, deprecated=None, by_alias=None, exclude_unset=None, exclude_defaults=None, exclude_none=None, url_name=None, include_in_schema=True, openapi_extra=None)`

`PUT` operation. See operations parameters reference.

Source code in `ninja/main.py`

    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336

    def put(
        self,
        path: str,
        *,
        auth: Any = NOT_SET,
        throttle: Union[BaseThrottle, List[BaseThrottle], NOT_SET_TYPE] = NOT_SET,
        response: Any = NOT_SET,
        operation_id: Optional[str] = None,
        summary: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        deprecated: Optional[bool] = None,
        by_alias: Optional[bool] = None,
        exclude_unset: Optional[bool] = None,
        exclude_defaults: Optional[bool] = None,
        exclude_none: Optional[bool] = None,
        url_name: Optional[str] = None,
        include_in_schema: bool = True,
        openapi_extra: Optional[Dict[str, Any]] = None,
    ) -> Callable[[TCallable], TCallable]:
        """
        `PUT` operation. See <a href="../operations-parameters">operations
        parameters</a> reference.
        """
        return self.default_router.put(
            path,
            auth=auth is NOT_SET and self.auth or auth,
            throttle=throttle is NOT_SET and self.throttle or throttle,
            response=response,
            operation_id=operation_id,
            summary=summary,
            description=description,
            tags=tags,
            deprecated=deprecated,
            by_alias=by_alias,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none,
            url_name=url_name,
            include_in_schema=include_in_schema,
            openapi_extra=openapi_extra,
        )