Skip to content

编写 API 使用示例 #8

@Jason-prd

Description

@Jason-prd

概述

当前 API 文档(/docs)已包含完整的接口定义,但缺少实际业务场景的使用示例。新贡献者或集成方难以快速上手。

需要补充的示例

1. 认证流程

POST /api/auth/register  - 用户注册
POST /api/auth/login     - 登录获取 token
GET  /api/auth/me        - 获取当前用户信息

2. 工作流 CRUD

使用 curl 或 Python 调用 API 创建、执行工作流,参考 examples/ 目录下的 JSON 文件。

3. Webhook 集成示例

用 Python httpx 调用执行状态查询接口。

4. 飞书集成示例

调用飞书消息发送接口,绑定工作流执行结果通知。

产出要求

  • backend/docs/ 下新增 API使用示例.md
  • 每个示例包含:场景描述、请求参数、响应示例、Python/curl 代码
  • 可参考 examples/ 目录下的工作流 JSON 文件设计真实场景

标签: good first issue documentation

欢迎程度: 非常适合文档型贡献,无需代码审查!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions