Features
Key capabilities and functionality
- Automatic OpenAPI/Swagger documentation generation
- Real-time documentation updates when API files change
- Support for JavaScript and Python API routes
- Extracts endpoint information and parameters
- Response type documentation extraction
- Multi-format output (JSON, Markdown)
Hook configuration and script content
Setup instructions and requirements
Claude Desktop Setup
- Create the hooks directory: mkdir -p .claude/hooks
- Create the script file: .claude/hooks/api-endpoint-documentation-generator.sh
- Make the script executable: chmod +x .claude/hooks/api-endpoint-documentation-generator.sh
- Add hook configuration to .claude.md file
Configuration Paths
macOS
~/.claude/config.jsonwindows
%APPDATA%\Claude\config.jsonlinux
~/.config/claude/config.jsonUse Cases
Common scenarios and applications
- Automatic API documentation in development workflows
- Keep OpenAPI specs synchronized with code changes
- Generate documentation for REST API endpoints
- Maintain up-to-date API reference docs
- Integration with Swagger UI for live documentation
Requirements
Prerequisites and dependencies
- Claude Desktop or Claude Code
- jq command-line tool for JSON parsing
- Node.js and npm
- Python 3.x
Troubleshooting
Common issues and solutions
jq command not found
Install jq: brew install jq (macOS) or apt-get install jq (Ubuntu)
Node.js or npm not found
Install Node.js from https://nodejs.org/ or use nvm
Python not found in PATH
Install Python 3.x from https://python.org/ or use package manager