DEV Community
·
如何自定义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中注册文档转换器以应用自定义文档。
❓
延伸问答
如何自定义API文档以添加webhook端点？
首先创建文档转换器，定义webhook的操作、请求体和响应，然后在服务提供者中注册该转换器。
AddWebhookDocumentationTransformer类的作用是什么？
该类用于定义webhook的操作、请求体和响应，并将其添加到API文档中。
webhook的schema包含哪些属性？
schema包含payer_id、payer_name、payer_document、payer_email、product_id、order_id、status、total、paid和paid_at等属性。
如何在Scramble中注册文档转换器？
在AppServiceProvider中使用Scramble::configure()方法注册AddWebhookDocumentationTransformer类。
添加webhook的请求体需要包含哪些内容？
请求体需要描述webhook发送的payload结构，并设置内容类型为application/json。
成功接收webhook的预期响应是什么？
预期响应为HTTP状态码200，表示webhook成功接收。
➡️
