api-docs-writer

仓库创建 2026年1月29日最近提交 12 小时前SkillHot 收录 20 天前

▸ 精选理由

输出可上生产的端点说明与请求/响应示例，节省大量工程时间。

这个 Skill 做什么

将接口规范或示例转换为清晰、可发布的开发者API文档。

把原始的接口规范、Postman 导出或零散说明，整理成开发者能直接用的 API 文档：端点说明、参数、请求/响应示例和错误码。适合要上 developer portal、写 README 或交给后端/前端同事时使用。遵循 OpenAPI 风格，产出可直接发布到门户或 Notion 的成品。

▸ 展开 SKILL.md 英文原文

Write clear, developer-facing API documentation. Use when asked to document an API endpoint, write API reference docs, create a developer guide, or turn a raw spec/Postman collection into documentation. Produces endpoint documentation with descriptions, parameters, request/response examples, and error codes.

开发编程API文档开发者指南OpenAPI通用

1.2k

Stars

220

Forks

仓库内 Skill

+74

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/mohitagw15856/pm-claude-skills/main/skills/api-docs-writer/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/mohitagw15856/pm-claude-skills/main/skills/api-docs-writer/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# API Docs Writer Skill

This skill transforms raw API specs, endpoint descriptions, or Postman collections into clean, developer-facing documentation following OpenAPI-adjacent conventions. Output is ready for a developer portal, README, or Notion/Confluence page.

## Required Inputs

Ask the user for these if not provided:
- **API or endpoint details** (raw spec, Postman export, or verbal description)
- **Auth method** (API key / Bearer token / OAuth 2.0 / None)
- **Base URL**
- **API version** (e.g. v1, v2.3, or "unversioned" — affects deprecation notes and versioning headers)
- **Rate limits** (requests per second/minute per token or IP, if known — or "unknown")
- **Audience** (internal

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有