Dokumentasi/Python API dan kesalahan

Pengecualian dan kesalahan

Sebuah permintaan bisa gagal di empat tempat, dan Nexy menjawab masing-masing permintaan secara berbeda. Halaman ini adalah indeksnya: temukan status yang Anda lihat, lalu baris yang menghasilkannya, lalu file yang menentukan isi.

Versi pendek

Klien API adalah permintaan yang header Accept-nya meminta JSON dan bukan halaman:

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

Dari mana sebuah kegagalan berasal

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

Berangkat dari mana saja

redirect, permanentRedirect, notFound, forbidden dan unauthorized memunculkan pengecualian HTTP, sehingga panggilan yang sama berfungsi di halaman .nexy, penangan API, pengontrol modular, penjaga, dependencies.py dan tindakan.

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

Bangun tujuan dari nilai-nilai yang Anda percayai. redirect(request.query_params["next"]) mengarahkan pengunjung ke mana pun yang disebutkan dalam tautan; ini adalah pengalihan terbuka. Tujuan yang memiliki jeda baris ditolak.

Validasi: 422, atau 404

Parameter handler divalidasi oleh FastAPI berdasarkan anotasinya.

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}

Isi 422 adalah bentuk standar FastAPI, sehingga klien dan SDK yang dihasilkan tetap berfungsi:

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

Untuk formulir atau tindakan, klien menerima ActionError dengan status dan detail; a 422 juga mengisi error.fields dengan satu pesan per kolom. Lihat Tindakan.

Halaman kesalahan khusus

<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>

Pengecualian yang tidak tertangani

Pengecualian bahwa tidak ada yang tertangkap dicatat satu kali, dengan referensinya, dari mana asalnya, dan kode di sekitarnya. Statusnya adalah 500, dan tubuhnya bergantung pada lingkungan.

  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}

Referensinya adalah delapan karakter, baru untuk setiap kegagalan. Pengunjung dapat mengutipnya, dan Anda menemukan penelusuran baliknya dengan mencari lognya. Baik pengecualian maupun kode tidak sampai ke pengunjung dalam produksi.

Tindakan dan bentuk

Suatu tindakan adalah titik akhir POST dengan jalur yang dihasilkan. Kegagalannya mengikuti aturan yang sama:

Formulir tanpa JavaScript memposting ke jalur tindakan; jika berhasil menjawab 303 kembali ke halaman, jika gagal menampilkan halaman kesalahan. Lihat Tindakan.

Daftar periksa ketika suatu halaman menjawab hal yang salah

1. Lihat statusnya, bukan halamannya. Sebuah kebiasaan notfound.nexy masih menjawab 404.
2. Baca terminal. Halaman yang gagal diimpor tidak terdaftar, jadi URL-nya menjawab 404 selagi file ada. Kesalahan impor ada di log.
3. Periksa ekstensinya. Dengan useCSR = True, .nexy halaman termasuk dalam mode server; halaman dalam mode yang salah bukanlah rute.
4. Periksa kedalamannya. notfound.nexy atau errors.nexy hanya berfungsi jika salinan root ada.
5. Minta JSON dengan Accept: application/json untuk melihat bentuk yang diterima klien API Anda.
6. Kutip referensi dari 500 ketika Anda membuka terbitan atau mencari log.

Langkah selanjutnya

• Halaman kesalahan: perilaku halaman penuh, dengan contoh
• Validasi dan kesalahan: penangan API
• Pemecahan masalah: kesalahan yang sebenarnya terjadi
• Pengujian: menegaskan status dan isi

Salin halaman sebagai Markdown Sunting di GitHub