如何在 Swagger 中记录 webhooks?

问题描述 投票:0回答:1

我正在构建一组 API 和 Webhook。对于常用的 API,我可以毫无问题地编写 YAML 文件来在 Swagger 中记录它。不过,我还想在 Swagger 文档中记录 Webhooks,例如它们的请求正文有效负载以及有关它们的其他信息。

Swagger 中通常如何记录 Webhook 或反向 API?

swagger webhooks documentation swagger-editor
1个回答
0
投票

OpenAPI 3.1 支持 Webhooks,当您发布此问题时,该支持可能不可用。

我注意到 3.0 有一个 x-webhooks 扩展,请参阅 https://redocly.com/docs-legacy/api-reference-docs/specation-extensions/x-webhooks 但我不确定它的支持范围有多大由 OpenAPI 客户端提供。

© www.soinside.com 2019 - 2024. All rights reserved.