For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 概览
    • 什么是 API 定义?
    • 项目结构
      • 概览
      • 身份验证
      • 类型
        • 概览
        • 环境
        • 全局请求头
        • 错误
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 通过状态码区分
  • 通过错误名称区分
  • 全局错误
Fern 定义api.yml 参考

错误处理

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

全局配置

下一个

Fern Definition 中的包

为了生成符合习惯的 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