-
Notifications
You must be signed in to change notification settings - Fork 0
编写 API 使用示例 #8
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
概述
当前 API 文档(
/docs)已包含完整的接口定义,但缺少实际业务场景的使用示例。新贡献者或集成方难以快速上手。需要补充的示例
1. 认证流程
2. 工作流 CRUD
使用 curl 或 Python 调用 API 创建、执行工作流,参考 examples/ 目录下的 JSON 文件。
3. Webhook 集成示例
用 Python httpx 调用执行状态查询接口。
4. 飞书集成示例
调用飞书消息发送接口,绑定工作流执行结果通知。
产出要求
backend/docs/下新增API使用示例.mdexamples/目录下的工作流 JSON 文件设计真实场景标签:
good first issuedocumentation欢迎程度: 非常适合文档型贡献,无需代码审查!