Pushpen reads your route code and generates accurate API documentation automatically. Endpoints, parameters, request bodies, response shapes, and auth requirements — extracted from your actual implementation, not from stale spec files.
API documentation is the contract between your service and its consumers. When that contract drifts from reality, integrations break, developers get frustrated, and your support queue grows. Pushpen eliminates drift by treating your source code as the single source of truth and generating API docs directly from it.
Start freeThe problem
Every new endpoint, changed parameter, or updated response schema creates a gap. When you ship multiple times per week, manual doc updates are the first thing cut from the sprint.
New hires struggle to onboard. External developers file bugs against endpoints that don't exist anymore. Your team answers the same questions about authentication and rate limits repeatedly.
How it works
Pushpen analyzes your route definitions, middleware, and schemas directly. What your code says is what your docs show — always.
Discovers all endpoints, HTTP methods, and path parameters from your route declarations and decorators.
Reads Pydantic models, TypeScript interfaces, and serializer definitions to document parameter types and validation rules.
Identifies auth guards, rate limiters, and permission checks applied to each endpoint group.
Produces Markdown or OpenAPI-compatible documentation. Review the PR, merge it, and your docs are current.
Benefits
Docs update with every push. No tickets, no doc sprints, no “update the API docs” checklist items.
New team members and external developers get accurate, current documentation that reflects the actual API, not what it did three months ago.
When docs match reality, developers spend less time guessing and more time building. Support questions about endpoint behavior drop significantly.
API documentation that automatically reflects your current endpoints and schemas makes compliance reviews and security audits straightforward.
FAQ
Pushpen supports REST APIs built with FastAPI, Express, Django REST Framework, Rails, Flask, and others. It automatically detects route decorators, path parameters, query parameters, and request body schemas.
Pushpen scans your middleware, decorators, and configuration for auth requirements — API keys, JWT, OAuth — and documents which endpoints require which method. It also detects rate-limiting headers and usage policies.
Yes. Pushpen generates PRs with documentation changes that you can review, edit, and extend before merging. You control the final output, including descriptions, examples, and formatting.
Yes. Pushpen works with any GitHub repository, public or private. Internal service APIs get the same automatic documentation as customer-facing ones.
Swagger/OpenAPI requires you to maintain annotations or separate spec files. Pushpen reads your actual route code directly — no annotations, no extra files, no duplicate definitions to keep in sync.