SuperAPI AI 工具集

021-architecture-functional-requirements-rest

智能体与模型

查看项目

更新于 10-16 09:02

技能介绍

用途

该技能面向 REST API 开发场景,帮助团队以结构化对话的方式,发现并记录 REST API 实现所涉及的技术决策与功能需求,并产出架构决策记录(ADR)。根据说明,ADR 是这场对话的文档化结果,而不是对话本身。

主要能力

技能覆盖的内容包括:

  • 初始上下文:API 目的、消费者、约束、负载。
  • 功能需求:用例、资源、操作、响应格式、错误处理。
  • 技术决策:语言/框架、API 设计、认证/安全、数据、集成、基础设施、测试、监控。
  • 决策综合与验证(在创建 ADR 之前)。
  • ADR 文档生成与后续步骤。

使用方式

该技能是一个交互式 SKILL,采用对话式发现流程。约束要求:

  • 使用对话式发现:一次提出 1 到 2 个问题,基于回答继续构建,推进前先验证。
  • 只有在充分对话并获得用户确认后,才创建 ADR。
  • 强制要求:开始前运行 date,以获得 ADR 所需的准确时间戳。
  • 必须重新读取参考模板,不要使用缓存的问题。
  • 必须一次只问一到两个问题,绝不要一次性全部提出。
  • 必须在提议创建 ADR 之前,向用户确认总结(“这是否准确描述了你的需求?”)。
  • 必须等待用户确认“proceed”(继续)后,才生成 ADR。

详细指导、示例与约束参见参考文件 references/021-architecture-functional-requirements-rest.md。

适用场景

适用于用户希望为 REST API 开发记录技术决策与功能需求、并形成 ADR 文档的情形。

限制

资料未提供关于收费、价格、平台支持范围等额外信息,这些内容暂未提供。执行流程须遵循上述强制约束,不得跳过对话、验证与用户确认步骤。