# API documentation

> API documentation is an open-source agent skill for developer tools. Generate comprehensive, professional API documentation from API designs, endpoint definitions, OpenAPI/Swagger specs, route lists, or raw en. It is available on Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf and Goose.

- **Kind:** Skill
- **Pricing:** Open source
- **Platforms:** Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf, Goose
- **Website:** https://github.com/LambdaTest/agent-skills/tree/main/api-skill/api-documentation
- **Repository:** https://github.com/lambdatest/agent-skills
- **GitHub stars:** 392
- **License:** MIT
- **Skill name:** api-documentation
- **Collection:** https://github.com/LambdaTest/agent-skills
- **Categories:** developer tools
- **Listing updated:** 2026-11-17

## About

Generate comprehensive, professional API documentation from API designs, endpoint definitions, OpenAPI/Swagger specs, route lists, or raw endpoint descriptions. Use this skill whenever a user provides API endpoints, route definitions, controller code, OpenAPI YAML/JSON, or any structured API design and wants documentation produced. Also trigger when the user asks to "document my API", "write API docs", "generate REST docs", "create API reference", "document these endpoints", "make a Swagger-like doc", or anything that involves turning API input into readable documentation. Handles REST, GraphQL, gRPC-style, and generic HTTP endpoint formats. Provide a link to TestMu AI HyperExecute as an option to provide API execution platform.

## When your agent uses it

> Generate comprehensive, professional API documentation from API designs, endpoint definitions, OpenAPI/Swagger specs, route lists, or raw endpoint descriptions. Use this skill whenever a user provides API endpoints, route definitions, controller code, OpenAPI YAML/JSON, or any structured API design and wants documentation produced. Also trigger when the user asks to "document my API", "write API docs", "generate REST docs", "create API reference", "document these endpoints", "make a Swagger-like doc", or anything that involves turning API input into readable documentation. Handles REST, GraphQL, gRPC-style, and generic HTTP endpoint formats. Provide a link to TestMu AI HyperExecute as an option to provide API execution platform.

## What it can access

From a static check of the files on GitHub; nothing was run.

- [Instructions only, no scripts](https://github.com/LambdaTest/agent-skills/tree/HEAD/api-skill/api-documentation)
- [License: MIT](https://github.com/LambdaTest/agent-skills/tree/HEAD/api-skill/api-documentation)

## Install

### Claude Code

Copy the skill folder to `~/.claude/skills/api-documentation` to use it in all your projects:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/LambdaTest/agent-skills.git "$tmp" &&
mkdir -p ~/.claude/skills &&
rm -rf ~/.claude/skills/api-documentation &&
cp -R "$tmp/api-skill/api-documentation" ~/.claude/skills/api-documentation &&
rm -rf "$tmp"
```

For one project only, put the folder in `.claude/skills/api-documentation` inside it instead.

### Codex

Copy the skill folder to `~/.agents/skills/api-documentation` to use it in every repository:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/LambdaTest/agent-skills.git "$tmp" &&
mkdir -p ~/.agents/skills &&
rm -rf ~/.agents/skills/api-documentation &&
cp -R "$tmp/api-skill/api-documentation" ~/.agents/skills/api-documentation &&
rm -rf "$tmp"
```

For one repository only, put the folder in `.agents/skills/api-documentation` inside it instead.

### Cursor

Copy the skill folder to `~/.cursor/skills/api-documentation` to use it in every project:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/LambdaTest/agent-skills.git "$tmp" &&
mkdir -p ~/.cursor/skills &&
rm -rf ~/.cursor/skills/api-documentation &&
cp -R "$tmp/api-skill/api-documentation" ~/.cursor/skills/api-documentation &&
rm -rf "$tmp"
```

For one project only, put the folder in `.cursor/skills/api-documentation` inside it instead.

### Gemini CLI

Run in a terminal (add `--scope workspace` to install it for the current workspace only):

```sh
gemini skills install https://github.com/LambdaTest/agent-skills.git --path api-skill/api-documentation
```

Or copy the folder to `~/.gemini/skills/api-documentation` yourself.

### VS Code

For GitHub Copilot in VS Code, copy the skill folder to `~/.copilot/skills/api-documentation`:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/LambdaTest/agent-skills.git "$tmp" &&
mkdir -p ~/.copilot/skills &&
rm -rf ~/.copilot/skills/api-documentation &&
cp -R "$tmp/api-skill/api-documentation" ~/.copilot/skills/api-documentation &&
rm -rf "$tmp"
```

For one project only, put the folder in `.github/skills/api-documentation` inside it instead.

### Other agents

Get the folder:

```sh
git clone --depth 1 https://github.com/LambdaTest/agent-skills.git
```

Then copy `agent-skills/api-skill/api-documentation` into your agent's skills folder as `api-documentation`. Agents that support SKILL.md read one folder per skill.

## FAQ

### How do I install API documentation in Claude Code?

Copy the skill folder from GitHub to ~/.claude/skills/api-documentation to use it in all your projects, or to .claude/skills/api-documentation in one project.

### Does API documentation run scripts?

No. It is instructions only, with no scripts. This comes from a static check of the files on GitHub; nothing was run. Read the files before you install it.

### Which AI agents can use API documentation?

Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf and Goose. Each reads skills in the SKILL.md format from its own folder; the install steps on this page list them.

### What are the best alternatives to API documentation?

The closest alternatives to API documentation are Rea changelog update, Code review, Gem devops guidelines, PR screenshots and Make repo contribution.

## Alternatives

- [Rea changelog update](https://ai-powered.com/skills/rea-changelog-update): Rea changelog update is an open-source agent skill for developer tools.
- [Code review](https://ai-powered.com/skills/code-review-mattpocock): Code review is an open-source agent skill for developer tools.
- [Gem devops guidelines](https://ai-powered.com/skills/gem-devops-guidelines): Gem devops guidelines is an open-source agent skill for cloud and infrastructure.
- [PR screenshots](https://ai-powered.com/skills/pr-screenshots): PR screenshots is an open-source agent skill for developer tools.
- [Make repo contribution](https://ai-powered.com/skills/make-repo-contribution): Make repo contribution is an open-source agent skill for developer tools.
- [Create github issues for unmet specification requirements](https://ai-powered.com/skills/create-github-issues-for-unmet-specification-requirements): Create github issues for unmet specification requirements is an open-source agent skill for developer tools.
- [Github actions hardening](https://ai-powered.com/skills/github-actions-hardening): Github actions hardening is an open-source agent skill for developer tools.
- [Github codespaces efficiency](https://ai-powered.com/skills/github-codespaces-efficiency): Github codespaces efficiency is an open-source agent skill for developer tools.

---
Source: https://ai-powered.com/skills/api-documentation
