api-reference-documentation

@aj-geddes · 收录于 5 天前 · 上游提交 4 个月前

Create comprehensive API reference documentation with OpenAPI/Swagger specs, REST endpoints, authentication, examples, and SDKs. Use when documenting REST APIs, GraphQL APIs, endpoint documentation, or OpenAPI specifications.

场景接口联调 api文档开发者协作

适合你，如果你需要为团队或用户编写规范的 API 参考文档

/ 下载安装

https://github.com/aj-geddes/useful-ai-prompts/tree/main/skills/api-reference-documentation ↗

/ 通过 npx 安装 校验哈希

npx oh-my-skill add aj-geddes/useful-ai-prompts/api-reference-documentation

/ 通过 bash 安装

curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- aj-geddes/useful-ai-prompts/api-reference-documentation

/ 已经装过?验证本机副本,不用重装

npx oh-my-skill verify aj-geddes/useful-ai-prompts/api-reference-documentation

安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。

300GitHub stars

~499最小装载

~1.9K含声明引用

~2.1K文本包总量

索引托管

怎么用

商店整理自技能原文 · 版本 3f5182c · 表述以原文为准

它做什么

生成包含端点说明、认证方式、请求响应示例和交互式文档的专业API参考文档。

什么时候触发

当你要求记录REST API、生成OpenAPI规范或文档化GraphQL API时触发。

装好后可以这样说

Claude会基于你提供的API信息生成规范。

Claude会生成包含详细认证和错误码的文档。

Claude会在文档中补充分页和限流参数。

技能原文 SKILL.md作者撰写 · MIT · 3f5182c

API Reference Documentation

[Overview](#overview)
[When to Use](#when-to-use)
[Quick Start](#quick-start)
[Reference Guides](#reference-guides)
[Best Practices](#best-practices)

Overview

Generate professional API documentation that developers can use to integrate with your API, including endpoint specifications, authentication, request/response examples, and interactive documentation.

When to Use

Documenting REST APIs
Creating OpenAPI/Swagger specifications
GraphQL API documentation
SDK and client library docs
API authentication guides
Rate limiting documentation
Webhook documentation
API versioning guides

Quick Start

Minimal working example:

openapi: 3.0.3
info:
  title: E-Commerce API
  description: |
    Complete API for managing e-commerce operations including products,
    orders, customers, and payments.

    ## Authentication
    All endpoints require Bearer token authentication. Include your API key
    in the Authorization header: `Authorization: Bearer YOUR_API_KEY`

    ## Rate Limiting
    - 1000 requests per hour for authenticated users
    - 100 requests per hour for unauthenticated requests

    ## Pagination
    List endpoints return paginated results with `page` and `limit` parameters.
  version: 2.0.0
  contact:
    name: API Support
    email: api@example.com
    url: https://example.com/support
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
// ... (see reference guides for full implementation)

Reference Guides

Detailed implementations in the references/ directory:

| Guide | Contents | |---|---| | [OpenAPI Specification Example](references/openapi-specification-example.md) | openapi: 3.0.3 | | [List Products](references/list-products.md) | List Products |

Best Practices

✅ DO

Use OpenAPI 3.0+ specification
Include request/response examples for every endpoint
Document all query parameters and headers
Provide authentication examples
Include error response formats
Document rate limits and pagination
Use consistent naming conventions
Include SDK examples in multiple languages
Document webhook payloads
Provide interactive API explorer (Swagger UI)
Version your API documentation
Include migration guides for breaking changes

❌ DON'T

Skip error response documentation
Forget to document authentication
Use inconsistent terminology
Leave endpoints undocumented
Ignore deprecation notices
Skip versioning information

按 MIT 许可原样转载,未经改动 · 在 GitHub 查看 →

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。

…