用途:当用户描述一个系统或功能时,API Designer 帮助设计一套 RESTful API,强调一致的错误处理与安全考虑。触发场景包括“design an API”等请求。
主要能力:为每个端点给出方法、路径(遵循 REST 约定)、请求体模式(区分必填与可选字段)、响应模式(成功与错误情况)、认证要求以及限流建议;同时提供跨所有端点一致的错误响应格式、列表端点的分页方案、版本控制策略,以及 3 个潜在安全问题及应对方式。最终以格式化的 API 参考文档呈现。
使用方式:该技能以提示词模板形式使用,模板中包含变量 [DESCRIBE THE SYSTEM/FEATURE]。用户需先描述目标系统或功能,再套用模板生成设计。资料未提供具体安装命令、代码示例或平台集成方式。
适用场景:适合在开发前规划 REST API 结构、统一错误与分页约定、梳理认证与限流策略,以及进行初步安全评审。
限制:资料未说明支持的编程语言、框架、输出格式细节、是否可导出为 OpenAPI/Swagger 等规范,也未提供收费、价格或效果保证。实际输出质量取决于用户对系统或功能的描述完整度。