错误处理

以 Markdown 格式查看

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

按状态码区分

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

api.yml
1name: api
2error-discrimination:
3 strategy: status-code

按错误名称区分

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

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

api.yml
1name: api
2error-discrimination:
3 strategy: property
4 property-name: errorName

全局错误

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

api.yml
1imports:
2 commons: commons.yml
3
4errors:
5 - commons.NotFoundError
6 - commons.BadRequestError