document_api
Generates standardized API documentation (OpenAPI/Markdown) for backend endpoints.
Best use case
document_api is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Generates standardized API documentation (OpenAPI/Markdown) for backend endpoints.
Teams using document_api should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/document_api/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How document_api Compares
| Feature / Agent | document_api | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Generates standardized API documentation (OpenAPI/Markdown) for backend endpoints.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Document API
Use this skill to automatically map out and document your server's API surface area.
## Inputs
* **Source Code**: The directory or entry point (e.g., `server.js`).
* **Format**: Preferred output (Markdown vs Swagger/OpenAPI).
## Tooling Strategy
* Use `grep_search` to find route definitions (e.g., `.get(`, `@app.route`).
* Use `view_file` to understand request/response schemas.
## Workflow
### 1. Analysis
* **Scan**: Identify the server entry point (e.g., `server.js`, `app.py`).
* **Route Discovery**: Trace route definitions (Express `.get()`, Flask `@app.route`, FastAPI decorators).
* **Parameters**: specific inputs (Body, Query Params, Path Variables).
### 2. Documentation Generation
* **Format**: Create/Update `API_DOCUMENTATION.md` (or generate a Swagger JSON if preferred).
* **Structure**:
* **Endpoint**: `METHOD /path`
* **Description**: What it does.
* **Request**:
* Headers (Auth?)
* Body Schema (JSON structure)
* **Response**:
* 200 Success: Example JSON
* 4xx/5xx Errors: Error codes
### 3. Output
* Make the documentation clear and consistent.
* Ensure every identified route is listed.Related Skills
web_performance_optimization
Optimize website and web application performance including loading speed, Core Web Vitals, bundle size, caching strategies, and runtime performance.
update_docs
Updates standard project documentation files (README, CODE_DOCUMENTATION, DESIGN_PHILOSOPHY) to reflect the current state of the codebase.
ui_ux_pro_max
UI/UX design intelligence with searchable database of patterns, styles, and stacks.
security_audit
Scans the codebase for OWASP Top 10 vulnerabilities (Secrets, Injection, Auth) and manages SECURITY.md.
scaffold_tests
Generates unit and regression test files for existing code. Creates "Happy Path", "Edge Case", and "Error" test stubs.
repo_infographic
Generates a crisp, clear full infographic of the repository with a unique theme based on the repo's content. Saves the infographic to the assets folder and links it in the README.md file.
release_helper
Automates release note generation and social media announcements. Handles version incrementing (minor vs major).
optimize_codebase
Identifies and refactors monolithic files (>2k lines) into modular, performance-safe component structures.
open_source_prep
Comprehensive workflow to prepare a project for public open-source release. Handles licensing, username normalization, code integrity checks, and documentation generation.
list_features
Scans the codebase to generate a comprehensive, prompt-based feature list in 'features_listed.md' for recreating the app in any language.
idea_to_action
Transforms abstract ideas into execution-ready systems. Follows the Brainstorm → Filter → Execute pipeline with a "Reality-First" founder mindset.
generate_release_image
create or edit promotional images for releases, adding version numbers, feature highlights, and modern styling.