用途
该技能面向 API 文档编写工作，帮助创建包含清晰参考、代码示例和开发者指南的完整 API 文档，便于开发者集成。
主要能力
根据资料，该技能覆盖以下文档编写场景：
- 记录 REST API
- 创建 API 参考
- 编写集成指南
- 提供代码示例
- 记录认证方式
- 解释错误码
- 记录速率限制
- 编写 SDK 文档
核心概念
1. API 参考结构
资料给出的参考结构示例包含：
- 接口定义，如
GET /users/{id}，用于按 ID 检索用户。 - 参数表，列出名称、类型、是否必填和描述，例如
id为 string 类型、必填、表示用户 ID。 - 请求示例，使用 curl 命令并携带
Authorization: Bearer YOUR_TOKEN请求头。 - 响应示例（200 OK），返回 JSON 对象，包含
id、name、email、created_at字段。 - 错误响应表，列出状态码与描述，例如 401 未授权（无效令牌）、404 用户不存在、429 超出速率限制。
2. OpenAPI 规范
资料提供了 OpenAPI 3.0.0 的 YAML 示例，包含 info（标题、版本）、paths（如 /users/{id} 的 get 操作、参数定义、响应定义）以及 components.schemas（如 User 对象的属性定义）。
最佳实践
资料列出的最佳实践包括：
- 清晰示例：展示请求和响应。
- 完整参考：记录所有参数。
- 错误码：记录所有可能的错误。
- 代码样例：提供多种语言。
- 认证：提供清晰的认证说明。
- 速率限制：记录限制和响应头。
- 版本管理：记录版本策略。
- 试用功能：提供交互式 API 探索器。
资源
- OpenAPI 规范：https://swagger.io/specification/
- Postman 文档：从集合生成文档。
限制
资料未提供该技能的具体安装方式、运行环境、收费模式、平台支持或实际效果等信息，这些内容暂未提供。