About Zudoku
Zudoku is an open source framework for building API documentation sites. It is developer-first and works from OpenAPI schemas, so the reference pages follow your API definition.
What it does
You add your OpenAPI v2 or v3 schema to a project and Zudoku generates an API catalog from it. The site includes an interactive playground for sending live requests, support for OAuth2, JWT and API key authentication, and built-in search powered by Pagefind. Pages can be built as fast static output and deployed to almost any host.
Key features
- Docs generated from OpenAPI v2 and v3 schemas
- Interactive playground for live API requests
- OAuth2, JWT and API key support
- Built-in search powered by Pagefind
- Static site output and MDX pages
Who it's for
API teams and developer relations groups who want reference docs and a developer portal in one place. It also suits teams that need a portal for internal APIs.
Pricing and good to know
Zudoku is listed under the MIT license and is free to use. Setup starts with an npm command and a project scaffold. Because the site is static, features that need a server must be added with a separate service or your own code.
Highlights
- Generates API docs from OpenAPI schemas
- Interactive playground for live requests
- Supports OAuth2, JWT and API keys
- Built-in search with Pagefind
- Builds static pages for any host
