Документация/Python API и ошибки

Исключения и ошибки

Запрос может завершиться неудачей в четырех местах, и Nexy отвечает на каждый из них по-разному. Эта страница является индексом: найдите статус, который вы видите, затем строку, которая его создала, затем файл, который определяет тело.

Краткая версия

Клиент API — это запрос, заголовок которого Accept запрашивает JSON, а не страницу:

curl -H "Accept: application/json" http://localhost:3000/api/items/500# {"detail":"Out of range"}

Откуда берется неудача

Browser ──► Middleware ──► Router ──► Page or handler
                 │            │             │
                 │            │             ├─ return ───────────► 200
                 │            │             ├─ HTTPException ────► its status
                 │            │             └─ other exception ───► 500
                 │            └─ no match ────────────────────────► 404
                 └─ raises ──────────────────────────────────────► 500

Уйти откуда угодно

redirect, permanentRedirect, notFound, forbidden и unauthorized вызывают исключение HTTP, поэтому один и тот же вызов работает на странице .nexy, обработчике API, модульном контроллере, защите, dependencies.py и действии.

from nexy import notFound, redirect from src.posts import find  async def GET(slug: str):    post = find(slug)    if post is None:        notFound("No such post")    if post.moved_to:        redirect(post.moved_to)    return post

from nexy import notFound, redirectfrom nexy.decorators import Controller from src.posts import find  @Controller("/posts/{slug}")class PostsBySlugController:    async def get(self, slug: str):        post = find(slug)        if post is None:            notFound("No such post")        if post.moved_to:            redirect(post.moved_to)        return post

Создайте пункт назначения на основе ценностей, которым вы доверяете. redirect(request.query_params["next"]) отправляет посетителей туда, где указано в ссылке; это открытое перенаправление. Пункт назначения, содержащий разрыв строки, отклоняется.

Проверка: 422 или 404.

Параметры обработчика проверяются FastAPI на соответствие их аннотациям.

from nexy.http import Header  async def GET(q: str, limit: int = 10, x_token: str = Header(...)):    return {"q": q, "limit": limit}

from nexy.decorators import Controllerfrom nexy.http import Header  @Controller("/api/search")class SearchApiController:    async def get(self, q: str, limit: int = 10, x_token: str = Header(...)):        return {"q": q, "limit": limit}

Тело 422 имеет стандартную форму FastAPI, поэтому клиенты и созданные SDK продолжают работать:

{"detail": [{"loc": ["query", "q"], "msg": "Field required", "type": "missing"}]}

Для формы или действия клиент получает ActionError с status и detail; 422 также заполняет error.fields одним сообщением в каждом поле. См. Действия.

Пользовательские страницы ошибок

<h1>Page not found</h1><p>The link may be old. <a href="/">Start from the home page</a>.</p>

<h1>Something went wrong</h1><p>Try again in a moment.</p>

Необработанные исключения

Исключение, когда ничего не обнаружено, записывается один раз со ссылкой на источник и код вокруг него. Статус 500, тело зависит от окружающей среды.

  x ZeroDivisionError: division by zero  GET /boom  ref fe6a5217    at src/routes/boom.py:2 in GET       1 | def GET():       2 |     return {"a": 1 / 0}

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

Действия и формы

Действие — это конечная точка POST со сгенерированным путем. Его неудачи подчиняются тем же правилам:

Форма без JavaScript сообщений о пути действия; при успехе ответ 303 возвращается на страницу, при неудаче отображается страница с ошибкой. См. Действия.

Контрольный список, когда страница отвечает не на тот вопрос

1. Смотрите на статус, а не на страницу. Пользовательский notfound.nexy по-прежнему отвечает на 404.
2. Прочтите терминал. Страница, которую не удалось импортировать, не зарегистрирована, поэтому ее URL-адрес отвечает 404, пока файл существует. Ошибка импорта есть в журнале.
3. Проверьте расширение. При useCSR = True, .nexy страницы относятся к режиму сервера; страница в неправильном режиме не является маршрутом.
4. Проверьте глубину. notfound.nexy или errors.nexy работает только при наличии корневой копии.
5. Запросите JSON с помощью Accept: application/json, чтобы увидеть форму, которую получает ваш API-клиент.
6. Цитируйте ссылку на 500 при открытии задачи или поиске в журнале.

Следующие шаги

• Страницы ошибок: полное поведение страницы с примерами.
• Проверка и ошибки: обработчики API
• Устранение неполадок: ошибки, с которыми люди действительно столкнулись
• Тестирование: подтверждение статуса и тела

Скопировать страницу как Markdown Изменить на GitHub