Небольшой API внутри core

Для первого endpoint достаточно схемы ответа и функции. Установите django-ninja в виртуальное окружение своего проекта. Создайте пакет core/api/ с пустым __init__.py. Файл api.py будет точкой подключения, а feature-модуль сохранит router, схемы и обработчики рядом.

Пример не использует базу и возвращает только публичную информацию о сервисе. Это позволяет сначала проверить маршрутизацию, документацию и форму JSON-ответа.

Пример кода
# core/api/status.py
from ninja import Router, Schema

router = Router(tags=["status"])

class StatusOut(Schema):
    status: str
    service: str

@router.get("/status", response=StatusOut)
def status(request):
    return {"status": "ok", "service": "notes"}

Подключение API к проекту

Общий объект NinjaAPI объединяет маршруты. В корневом URLconf подключите его под префиксом api/. Схемы, используемые только одним router, можно оставить в его модуле; отдельная общая папка нужна, когда появится реальное переиспользование.

Пример кода
# core/api/api.py
from ninja import NinjaAPI
from .status import router

api = NinjaAPI(title="Notes API", version="1.0.0")
api.add_router("", router)

# config/urls.py — импорт и элемент urlpatterns
from core.api.api import api
# path("api/", api.urls),

Что проверить перед следующим endpoint

В локальном окружении откройте /api/status: ожидается JSON со статусом ok. Страница /api/docs показывает схему и позволяет выполнить запрос. Проверьте код ответа, Content-Type и имена полей, а не только появление текста в браузере.

Перед добавлением закрытых данных определите способ аутентификации и права доступа. Наличие схемы не заменяет авторизацию. Для следующего endpoint выберите одну бизнес-операцию и держите проверки, основной вызов и ответ в читаемом порядке.