本技能聚焦 API 文档的规范与最佳实践。
用途：为 REST 与 GraphQL API 编写结构化、可维护的文档，覆盖规范定义、参考文档组织与交互式工具选型。
主要能力： 一、OpenAPI 3.0：介绍 OpenAPI 根对象、Info、Paths、Components、Security、Servers 等对象；说明 paths 下的 HTTP 方法、参数（query/path/header/cookie）、请求体、响应、示例、标签等要素。 二、REST 文档模式：端点文档需包含 URL 模式、HTTP 方法、说明、参数、请求体、响应与鉴权；响应文档需区分成功与错误响应、HTTP 状态码、响应 schema 与多场景示例；分页需记录分页参数、响应元数据（总数、页数、上下页链接）及默认与最大页大小建议。 三、GraphQL 文档：记录类型、字段、查询与变更、订阅与指令，以及操作名、参数、返回类型、示例与错误处理。 四、参考文档结构：包含概览、鉴权、快速上手、端点、数据模型、错误码、速率限制与变更日志；端点可按资源分组，提供导航、搜索、过滤与在线试调。 五、交互式工具：Swagger UI 支持探索与 Try it out、自定义主题、静态部署与实时校验；Redoc 提供三栏布局、全文搜索、移动端适配与代码示例生成；Stoplight 提供可视化设计、Mock 服务、测试与协作。 六、代码示例与 SDK 文档：提供多语言（JavaScript、Python、Java、cURL 等）完整可运行示例，并说明 SDK 安装、初始化、鉴权、方法、示例与错误处理；cURL 示例需含完整命令、请求头、鉴权与请求体。
使用方式与限制：公开资料未提供具体安装命令、运行步骤或集成方式，暂未提供；未说明定价、平台支持与效果指标。