RunLogosRunLogos
中文EN

Phase 04 · API 设计

API Skill 会读取场景时序图并生成完整 OpenAPI 规格。每个端点都应追溯到某个场景步骤,避免 AI 临场发明接口。

产物内容

logos/resources/api/ 中会包含 OpenAPI YAML,通常覆盖:

  • 路径和 HTTP 方法
  • 请求参数和请求体 Schema
  • 响应 Schema 与状态码
  • 鉴权要求
  • 统一错误响应结构

可追溯性

规格中的接口应能追溯到场景步骤:

/auth/register:
  post:
    summary: Register a new user
    # Scenario: S01 step 2
    requestBody:
      required: true

在 RunLogos 中查看

RunLogos 会用 OpenAPI 可视化编辑器展示端点列表、请求字段、响应结构和调试入口。你可以在实现前审查契约是否完整。

下一步

Phase 05 · 数据库设计