如何与OpenAPI定义的Webhook交互及相关实现疑问

核心问题确认 #

你的理解完全正确：当newPet事件触发时，提供Webhook的服务端会发送携带Pet结构数据的POST请求，并且期望接收方返回200状态码，以此确认数据已成功接收。

子问题逐一解答 #

• 请求将发送至哪个URL？
  OpenAPI规范的webhooks字段仅定义Webhook的请求/响应结构，不包含目标URL。具体接收URL由API用户在订阅时提供，属于服务实现层面的细节，不在OpenAPI文档的定义范围内。

• API用户能否注册接收该请求的URL？
  可以，但注册流程不属于OpenAPI规范的内容。通常服务会提供额外的API接口（比如/webhook-subscriptions）让用户提交接收URL，或者通过管理控制台配置，具体需参考服务的实现文档。

• API用户若不再希望接收newPet事件相关的POST请求，如何取消订阅？
  取消订阅的方式同样是服务实现细节，OpenAPI规范不做强制规定。常见方式包括调用专门的取消订阅API、在管理控制台删除订阅配置等。

• 所使用的协议是否仍为HTTP？
  是的，示例中明确使用post方法，说明基于HTTP/HTTPS协议。OpenAPI的Webhook定义默认基于HTTP协议，若使用其他协议（如WebSocket）需额外扩展定义，但主流场景均采用HTTP/HTTPS。

内容的提问来源于stack exchange，提问作者Balázs Édes