Api Documenting
Takes your API code and turns it into actual documentation, whether you need markdown for your README or a full OpenAPI spec. It scans route definitions across frameworks like Express and FastAPI, pulls out endpoints, parameters, and schemas, then formats everything consistently. Comes with detection scripts and validation tools, plus templates for both human-readable docs and machine-readable specs. Honest take: this is the kind of thing you put off until a week before launch, so having it automated with consistent templates saves you from that scramble. The framework detection is handy if you're working across multiple codebases with different routing setups.
- GitHub stars
- 826
- last updated
- May 30, 2026
Install
$ npx -y skills add huangjia2019/claude-code-engineering --skill api-documenting --agent claude-codeInstalls into .claude/skills of the current project.
Files
API Documentation Generator
Generate comprehensive API documentation from source code.
Quick Reference
For common documentation patterns, see PATTERNS.md.
Documentation Standards
See STANDARDS.md for our documentation conventions.
Process
Step 1: Identify API Endpoints
Look for:
- Route definitions (Express, FastAPI, etc.)
- Controller methods
- Handler functions
Step 2: Extract Information
For each endpoint, extract:
- HTTP method (GET, POST, PUT, DELETE, etc.)
- Path/route
- Parameters (path, query, body)
- Request/response schemas
- Authentication requirements
Step 3: Generate Documentation
Use the template in templates/endpoint.md for consistent formatting.
Step 4: Create Overview
Generate an index of all endpoints with the template in templates/index.md.
Output Formats
Markdown (Default)
Generate markdown documentation suitable for README or docs site.
OpenAPI/Swagger
If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml for structure.
Examples
See EXAMPLES.md for sample inputs and outputs.
Scripts
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/huangjia2019/claude-code-engineering
- Categories
- Backend & APIs, Documentation
- First seen
- Jun 11, 2026
More from huangjia2019/claude-code-engineering
All 11Recommended
More Backend & APIs
sqlalchemy-orm-expertmanutej/luxor-claude-marketplaceComprehensive SQLAlchemy skill for customer support tech enablement, covering ORM patterns, session management, query optimization, async operations, and Postgr0skills.sh installs
supabase-postgres-best-practicessyahiidkamil/software-engineer-ai-agent-atlasPostgres performance optimization and best practices from Supabase. Use this skill when writing, reviewing, or optimizing Postgres queries, schema designs, or d0skills.sh installs
Create database migrationTryGhost/GhostCreate a database migration to add a table, add columns to an existing table, add a setting, or otherwise change the schema of Ghost's MySQL database.0skills.sh installs
golang-graphqlsamber/cc-skills-golangImplements GraphQL APIs in Golang using gqlgen or graphql-go. Apply when building GraphQL servers, designing schemas, writing resolvers, handling subscriptions,38.5Kskills.sh installs
expo-api-routesexpo/skillsGuidelines for creating API routes in Expo Router with EAS Hosting37.2Kskills.sh installs
firebase-firestore-enterprise-native-modefirebase/agent-skillsComprehensive guide for Firestore enterprise native including provisioning, data model, security rules, and SDK usage. Use this skill when the user needs help s36Kskills.sh installs