跳到导航

错误处理

以 Markdown 格式查看

为了生成符合习惯的 SDK,Fern 需要知道在解析端点响应时如何区分不同的错误。

通过状态码区分

您可以指定 Fern 通过状态码进行区分。这意味着在每个端点上,列出的每个错误都必须具有不同的 HTTP 状态码。

api.yml
name: api
error-discrimination:
strategy: status-code

通过错误名称区分

您可以指定 Fern 通过错误名称进行区分。如果选择此策略,则 Fern 将假设每个错误响应都有一个额外的属性来表示错误名称。

如果您使用 Fern 生成服务器端代码,那么此选项提供了最大的灵活性。否则,您可能希望使用状态码区分策略。

api.yml
name: api
error-discrimination:
strategy: property
property-name: errorName

全局错误

您可以导入和列出将由每个端点抛出的错误。

api.yml
imports:
commons: commons.yml
errors:
- commons.NotFoundError
- commons.BadRequestError