Agent skill

API Reference Documentation

by secondsky in secondsky/claude-skills

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples.

MITAuto-check passedBackend & APIs

Install API Reference Documentation

skills CLI
$ npx skills add secondsky/claude-skills --skill api-reference-documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install secondsky/claude-skills api-reference-documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/secondsky/claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/api-reference-documentation/skills/api-reference-documentation .claude/skills/api-reference-documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-reference-documentation
GitHub stars
227
Used in
1 other repo
Token cost
~561 tokens
SKILL.md length
79 words
Files
1
Skills in repo
169
Repo updated
First seen
Licence
MIT

At a glance

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples.

  • Documenting REST APIs
  • SKILL.md covers OpenAPI 3.0 Specification, Documentation Checklist, Best Practices and Tools
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Creating SDK references

What it does

API Reference Documentation is an agent skill from secondsky/claude-skills. Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.

Its SKILL.md is about 560 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering OpenAPI specifications, Technical documentation and REST APIs. It works with OpenAPI. The repository describes itself as: Production-ready skills for Claude Code CLI - Cloudflare, React, Tailwind v4, and AI integrations. The licence is MIT.

When your agent uses it

  • Documenting REST APIs
  • Creating SDK references
  • Building developer portals

Example prompts

  • “Use the api-reference-documentation skill to create professional API documentation using OpenAPI specifications with endpoints, authentication, and…”
  • “/api-reference-documentation”

What it can do on your machine

Read from SKILL.md and the folder at commit 8837836. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are yaml).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Reference Documentation loads about 561 tokens when it runs. Until then it costs about 60 tokens; SKILL.md has 79 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~60
When it runs · the whole SKILL.md, loaded when a task matches
~561

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from secondsky/claude-skills at commit 8837836, republished under its MIT licence (© secondsky). 79 words, ~561 tokens.

Download SKILL.mdSave it as .claude/skills/api-reference-documentation/SKILL.md (or your agent's skills folder).
name
api-reference-documentation
description
Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.
license
MIT

API Reference Documentation

Create comprehensive API documentation for developer integration.

OpenAPI 3.0 Specification

yaml
openapi: 3.0.3
info:
  title: E-Commerce API
  version: 1.0.0
  description: API for managing products and orders
  contact:
    email: api@example.com

servers:
  - url: https://api.example.com/v1
    description: Production
  - url: https://staging-api.example.com/v1
    description: Staging

security:
  - bearerAuth: []

paths:
  /products:
    get:
      summary: List products
      tags: [Products]
      parameters:
        - name: limit
          in: query
          schema: { type: integer, default: 20 }
        - name: category
          in: query
          schema: { type: string }
      responses:
        '200':
          description: Product list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductList'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    Product:
      type: object
      required: [id, name, price]
      properties:
        id: { type: string, format: uuid }
        name: { type: string, maxLength: 200 }
        price: { type: number, minimum: 0 }
        description: { type: string }

Documentation Checklist

  • All endpoints documented with examples
  • Authentication methods explained
  • Error responses specified
  • Rate limits documented
  • Pagination explained
  • Webhooks documented (if applicable)
  • SDK examples in multiple languages

Best Practices

  • Use OpenAPI 3.0+ specification
  • Include request/response examples
  • Document all parameters and headers
  • Provide authentication examples
  • Enable interactive API exploration
  • Maintain version documentation
  • Include migration guides for breaking changes

Tools

  • Swagger Editor / Swagger UI
  • Redoc
  • Postman Documentation
  • Stoplight

© secondsky, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in plugins/api-reference-documentation/skills/api-reference-documentation of secondsky/claude-skills.

Open the folder on GitHubat commit 8837836

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in secondsky/claude-skills, which our catalogue first saw on October 7, 2026.

Compare with similar skills

API Reference Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Reference Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Reference Documentation this skillsecondsky/claude-skills2271 repos~561Automated safety check: PassMIT
OpenAPI Spec Generationwshobson/agents40k9 repos~511Automated safety check: PassMIT
Inngest APIAsymmetric-al/core382—~1.5kAutomated safety check: PassAGPL-3.0
Document API Endpointgetsentry/skills1k—~1.1kAutomated safety check: PassApache-2.0
API Documenteraiskillstore/marketplace4307 repos~2.1kAutomated safety check: PassNone
REST API Expertcin12211/orca-q223—~3.2kAutomated safety check: PassMIT

Similar skills

  • Create, validate and maintain OpenAPI 3.1 specs for REST APIs, whether designed first or generated from existing code, and use them for docs and client SDKs.

    40k GitHub starsUsed in 9 repos~511 tokens
    Backend & APIsAuto-check passed
  • Inngest API

    Asymmetric-al/core

    A skill your agent uses when the user explicitly asks for the Inngest REST API v2, raw HTTP, OpenAPI, API docs, API authentication, or an endpoint that the Inngest CLI does not expose.

    382 GitHub stars~1.5k tokensUpdated today
    Backend & APIsAuto-check passed
  • Document API Endpoint

    getsentry/skills

    Official

    Document and type a Sentry API endpoint. An agent skill from getsentry/skills.

    1k GitHub stars~1.1k tokensUpdated 4 days ago
    Backend & APIsAuto-check passed
  • API Documenter

    aiskillstore/marketplace

    Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices.

    430 GitHub starsUsed in 7 repos~2.1k tokens
    Backend & APIsAuto-check passed
  • REST API Expert

    cin12211/orca-q

    REST API design and development expert specializing in endpoint design, HTTP semantics, versioning, error handling, pagination, and OpenAPI documentation.

    223 GitHub stars~3.2k tokensUpdated 16 days ago
    Backend & APIsAuto-check passed
  • REST API Design

    curiositech/some_claude_skills

    Design REST API endpoints with Zod validation and OpenAPI documentation.

    243 GitHub starsUsed in 1 repo~3.1k tokens
    Backend & APIsAuto-check passed

More from secondsky/claude-skills

All 169 skills in this repo
  • Tanstack AI

    secondsky/claude-skills

    TanStack AI (alpha) provider-agnostic type-safe chat with streaming for OpenAI, Anthropic, Gemini, Ollama.

    227 GitHub starsUsed in 1 repo~3.6k tokens
    Auto-check: notes
  • Auto Animate

    secondsky/claude-skills

    AutoAnimate (@formkit/auto-animate) zero-config animations for React.

    227 GitHub stars~2.9k tokensUpdated 9 days ago
    Auto-check passed
  • Base UI React

    secondsky/claude-skills

    MUI Base UI unstyled React components with Floating UI. An agent skill from secondsky/claude-skills.

    227 GitHub stars~1.9k tokensUpdated 9 days ago
    Auto-check passed
  • Cloudflare Images

    secondsky/claude-skills

    This skill should be used when the user asks to "upload images to Cloudflare", "implement direct creator upload", "configure image transformations", "optimize WebP/AVIF", "create image variants"…

    227 GitHub stars~3.6k tokensUpdated 9 days ago
    Auto-check: notes
  • Cloudflare Nextjs

    secondsky/claude-skills

    Deploy Next.js to Cloudflare Workers via the OpenNext adapter (@opennextjs/cloudflare).

    227 GitHub stars~5.3k tokensUpdated 9 days ago
    Auto-check: notes
  • Cloudflare Sandbox

    secondsky/claude-skills

    Cloudflare Sandboxes SDK for secure code execution in Linux containers at edge.

    227 GitHub stars~4.5k tokensUpdated 9 days ago
    Auto-check passed

Works with

Categories

Questions about API Reference Documentation

What does API Reference Documentation do?

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. API Reference Documentation is an agent skill from secondsky/claude-skills. Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples.

When should I use API Reference Documentation?

API Reference Documentation fits situations like: documenting REST APIs; creating SDK references; building developer portals.

How do I install API Reference Documentation in Claude Code?

Run `npx skills add secondsky/claude-skills --skill api-reference-documentation -a claude-code`. Or copy the skill folder (plugins/api-reference-documentation/skills/api-reference-documentation in secondsky/claude-skills) into .claude/skills/api-reference-documentation in your project. Claude Code loads it when a task matches its description.

How do I install API Reference Documentation in Codex?

Run `npx skills add secondsky/claude-skills --skill api-reference-documentation -a codex`. Or copy the skill folder (plugins/api-reference-documentation/skills/api-reference-documentation in secondsky/claude-skills) into .agents/skills/api-reference-documentation in your project. Codex loads it when a task matches its description.

Can I use API Reference Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add secondsky/claude-skills --skill api-reference-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-reference-documentation, .gemini/skills/api-reference-documentation, .github/skills/api-reference-documentation and .opencode/skills/api-reference-documentation in your project.

What does API Reference Documentation need to run?

SKILL.md names no scripts, command-line tools or credentials: API Reference Documentation is instructions for the agent only.

Does API Reference Documentation access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Reference Documentation safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Reference Documentation use?

API Reference Documentation is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Reference Documentation use?

About 561 tokens (SKILL.md is roughly 2.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Reference Documentation?

Skills that share tags, products or a category with API Reference Documentation: OpenAPI Spec Generation (wshobson/agents, 40k stars), Inngest API (Asymmetric-al/core, 382 stars), Document API Endpoint (getsentry/skills, 1k stars) and API Documenter (aiskillstore/marketplace, 430 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Reference Documentation?

secondsky (a GitHub user) maintains it in secondsky/claude-skills, which has 227 GitHub stars. The repository holds 169 skills in this directory. The repository was last updated on September 28, 2026.

Source: secondsky/claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.