SuperAPI AI 工具集

api-portal-design

写作与研究

查看项目

更新于 10-16 00:23

技能介绍

用途:该技能面向 API 文档与开发者门户设计任务,适用于设计或规划门户内容、遵循既有 API 文档标准与最佳实践的场景。

主要能力:提供开发者门户的架构组件划分(快速开始、API 参考、代码示例、API 控制台、SDK 与库、变更日志、状态页、支持中心、认证与密钥),并给出内容结构表,按优先级列出必备章节(快速开始、认证、API 参考、代码示例为 P0;SDK、变更日志、速率限制、错误为 P1;Webhooks、最佳实践为 P2)。包含快速开始指南、认证文档(API Key 与 OAuth 2.0 授权码流程、OAuth 端点、权限范围、令牌刷新)、OpenAPI 3.1.0 规范模板、错误处理文档(HTTP 状态码、错误响应格式与错误码参考)。

必要用法:资料要求先调用 docs-management 技能获取 API 文档模式,并通过 MCP 服务器(context7)核验 OpenAPI/AsyncAPI 标准,以行业最佳实践为基础。示例命令保持原样,例如获取当前用户: curl -X GET "https://api.example.com/v1/users/me" -H "Authorization: Bearer YOUR_API_KEY" 令牌刷新示例: curl -X POST "https://auth.example.com/oauth/token" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=refresh_token" -d "refresh_token=YOUR_REFRESH_TOKEN" -d "client_id=YOUR_CLIENT_ID" -d "client_secret=YOUR_CLIENT_SECRET"

适用场景:需要编写或评审 API 门户内容、设计认证与错误说明、制定 OpenAPI 描述规范时。

限制:资料未提供该技能的具体安装命令、收费、平台或效果数据,暂未提供。