生成 Webhook 参考文档

Fern 从 OpenAPI 规范生成 Webhook 参考文档。

Fern 通过以下方式支持 webhooks：

• OpenAPI 3.1+：使用原生的 webhooks 字段和 operationId（推荐）
• OpenAPI 3.0：使用 x-fern-webhook: true 扩展

配置

1
api:
2
  path: openapi/openapi.yml

1
navigation:
2
  - api: Webhook Reference
3
    api-name: webhooks-v1

有关从 API 定义生成的 webhook 文档的实际示例，请查看 Webflow 的 webhooks。

包含多个 Webhook 参考文档

要在文档中包含多个 webhook 定义，请使用 api-name 属性。api-name 对应于包含您的 webhook 定义的文件夹名称。

1
navigation:
2
  - api: Payment Webhooks
3
    api-name: payment-webhooks
4
  - api: Order Webhooks
5
    api-name: order-webhooks

引用单独的 webhook 事件

要将每个 webhook 事件显示为单独的页面，请使用 subpackage_{tag}.{webhook-event-name} 格式在 layout 中引用它：

1
navigation:
2
  - api: Webhook Reference
3
    api-name: webhooks-v1
4
    layout:
5
      - subpackage_plants.newPlantWebhook

其中 {tag} 是第一个标签（小写），{webhook-event-name} 是您的 webhook 定义中的 operationId。