Skip to main content
skill

api-documentation-generator — Claude Code skill: setup guide

Analyzes your codebase to produce API reference pages for REST and GraphQL services. Includes request payloads, status codes, and code snippets.

Install into Claude Code · claude-code-templates All methods and platforms ↓
npx claude-code-templates@latest --skill development/api-documentation-generator
Open on GitHub

What api-documentation-generator does

Inspects server route declarations directly from your repository. It outlines HTTP methods, path variables, payload validations, and expected response codes. This helps when onboarding teammates or sharing public guides.

Produces call examples in cURL and JavaScript. It also documents authentication flows, pagination parameters, rate limits, and failure responses.

Can prepare an OpenAPI specification if needed. Precise outputs require Claude Code to access your router and model source files.

What it helps with

  • inspect source code to document routes, parameters, and responses
  • create reproducible request samples in cURL and JavaScript
  • build error resolution guides with specific status codes
  • export OpenAPI specifications and Postman collections from endpoints

Example prompts for the agent

  • Inspect the routes in src/api and build an API reference document
  • Document our auth endpoints with token refresh steps and cURL snippets
  • Generate an OpenAPI spec based on the controllers in this repository

How to install api-documentation-generator

1claude-code-templates

npx claude-code-templates@latest --skill development/api-documentation-generator

2Skills CLI (Vercel)

npx skills add davila7/claude-code-templates --skill api-documentation-generator -a claude-code

3Manually: put the files in place

~/.claude/skills/api-documentation-generator/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/api-documentation-generator/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about api-documentation-generator

How do I install api-documentation-generator in Claude Code?

Run npx claude-code-templates@latest --skill development/api-documentation-generator in your project terminal.

Which API architectures can this skill document?

It covers REST endpoints, GraphQL queries and mutations, as well as WebSocket interfaces.

What code snippets does it include in endpoint guides?

It generates commands for cURL, JavaScript snippets with fetch or axios, and Python examples using requests.

Similar skills

All skills for Backend and APIs →

From the same set804

The whole set →

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor