Skip to content

[Backend] API 文档化与压测基线(Swagger/OpenAPI) #7

Description

@Cai-Tang-www

背景

后端能力逐步丰富,但缺少可消费的 API 契约与性能基线,影响协作和对外展示。

问题

  • API 规范未统一沉淀
  • 新增 runs 接口缺乏可视化文档
  • 没有固定压测基线数据

目标

补齐 OpenAPI 文档与基础压测报告,形成可复用的工程交付资产。

建议改造

  1. 引入 Swagger/OpenAPI 生成流程
  2. 为 auth/chat/runs 等核心接口补齐 schema 与示例
  3. 增加压测脚本(如 k6/hey)与标准场景
  4. 输出压测结果(QPS、P95、错误率)并入仓库文档

验收标准

  • 本地可访问 Swagger 文档页
  • 核心接口均有请求/响应定义
  • 至少一份可复现压测报告

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions