文档/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"}]}

对于表单或操作，客户端会收到带有 status 和 detail 的 ActionError； a 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 上编辑