如何自定义Scramble – Laravel OpenAPI文档

如何自定义Scramble – Laravel OpenAPI文档

💡 原文英文,约400词,阅读约需2分钟。
📝

内容提要

我尝试自定义API文档,添加webhook端点。首先创建文档转换器,定义webhook的操作、请求体和响应,然后在服务提供者中注册该转换器,以便在文档中添加相应路径。

🎯

关键要点

  • 尝试自定义API文档,添加webhook端点。
  • 创建文档转换器以定义webhook的操作、请求体和响应。
  • 使用Scramble库创建AddWebhookDocumentationTransformer类。
  • 定义webhook的操作,包括操作ID、安全性、摘要和描述。
  • 定义webhook的schema,包括payer_id、payer_name、payer_document等属性。
  • 添加请求体,描述webhook发送的payload结构。
  • 添加预期响应,描述成功接收webhook的情况。
  • 创建/webhook路径并将其添加到文档中。
  • 在Scramble中注册文档转换器以应用自定义文档。
➡️

继续阅读