SuperAPI AI 工具集

developer-platform-design

设计与创作

查看项目

更新于 10-15 21:12

技能介绍

用途:面向开发者设计产品,覆盖 API 文档、CLI 界面与开发者体验(DX)。

主要能力与原则: 开发者体验:首次 API 调用时间应小于 5 分钟,否则说明上手流程有问题;展示而非描述,代码示例优于段落;每个代码示例应可直接复制粘贴运行;错误信息即文档,需在错误输出中包含修复建议;探索阶段不要求注册,文档应公开。

文档:首页提供快速开始指南;交互式 API 浏览器(try-it-now);多语言代码示例;变更日志需清晰标注破坏性变更;文档中链接状态页。

CLI 设计:--help 要真正有用;彩色输出提升可读性;长操作显示进度指示;破坏性操作需确认提示;提供 JSON 输出选项以便脚本化。

控制台:API 密钥管理(创建、撤销、轮换);用量指标与配额;日志与错误追踪;Webhook 管理与测试。

适用场景:设计或评审面向开发者的 API、CLI 工具、文档站点与开发者控制台。

限制:资料未提供具体实现代码、工具链、收费或平台信息。