mcpField
A
api-documentation-writer

api-documentation-writer

github.com/onewave-ai开发393373 次安装1 周前更新
代码仓库

关于 api-documentation-writer

用于编写全面、面向开发者的 API 文档的 Skill。它引导作者整理 API 信息、示例、错误与限流说明，并支持 REST、GraphQL 等 API 类型。

主要功能

  1. 01收集 API 信息
  2. 02按结构组织文档章节
  3. 03REST 与 GraphQL 示例
  4. 04错误及限流说明
  5. 05curl、JavaScript 和 Python 示例
  6. 06文档质量检查清单

适用场景

  1. 01编写 REST 端点文档
  2. 02创建 OpenAPI 规范
  3. 03说明 GraphQL Schema
  4. 04编写 Webhook 或认证指南

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/onewave-ai/claude-skills --skill api-documentation-writer

安装后在 Claude Code 中输入/api-documentation-writer确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
best-practices.md
documentation-structure.md
output-template.md

详细介绍

API 文档编写器

生成全面且对开发者友好的 API 文档。

内容

  • references/documentation-structure.md — 需要涵盖的所有章节（概述、身份验证、端点、错误、速率限制、SDK、Webhook、GraphQL）
  • references/output-template.md — 附带完整示例的规范 REST Markdown 模板
  • references/best-practices.md — 最佳实践、开发者体验建议和输出质量检查清单

工作流

  1. 收集 API 信息。确定 API 类型（REST、GraphQL、WebSocket、gRPC）、身份验证方式（API 密钥、OAuth、JWT）、基础 URL 和版本控制策略、可用端点及其用途、请求/响应格式，以及任何速率限制或使用限制。

  2. 构建文档结构。涵盖 references/documentation-structure.md 中的所有章节，并将最常见的操作排在前面。

  3. 生成输出。对于 REST API，请遵循 references/output-template.md；对于 GraphQL，请改用架构、查询、变更和订阅示例。将所有占位符替换为真实示例数据，并展示请求和响应。

  4. 编写错误和速率限制文档。包括标准错误响应格式、常见错误代码、故障排除指南、限制、需要检查的标头，以及如何处理 429 响应。

  5. 提供多种语言的代码示例（curl、JavaScript、Python），并链接可用的 SDK、Postman 集合或 OpenAPI 规范。

  6. 在交付前，根据 references/best-practices.md 中的检查清单核验质量。

示例触发语

  • “为我的 REST 端点编写 API 文档”
  • “为我的 API 创建 OpenAPI 规范”
  • “为这个 GraphQL 架构编写文档”
  • “为我的 Webhook API 生成开发者文档”
  • “编写 API 身份验证指南”

评论

支持 Markdown