Welcome to Doctopus
Beautiful documentation. Your infrastructure. Try the experience without a backend.
Your API deserves a great first impression
Doctopus turns API specifications into beautiful, self-hosted documentation. Orbit, our fictional API for projects and webhooks, supplies the sample data. This demonstration is a complete static documentation site, built from Markdown and an OpenAPI specification and hosted on GitHub Pages.
Try everything with mock data. Open any endpoint, choose Try now, then Send mock. Responses are generated in your browser from bundled examples. No API server, account, credentials or database is involved. Edits do not persist or create real resources.
Make yourself at home
- Explore the reference. Inspect parameters, request bodies, nested schemas and documented responses.
- Try the playground. Change request inputs, copy a URL or snippet, generate a response and expand it fullscreen. The response editor supports syntax highlighting, folding and copying.
- Choose your workspace. Open reader settings for prepared themes, system/light/dark appearance, and a classic collapsed endpoint list. Response colors follow your theme automatically.
- Find your way. Search the site, filter All / Documentation / API Reference, and resize the modern navigation and inspector panels.
Built for your stack
Doctopus builds static sites from YAML or JSON API specifications. Java and Spring Boot adapters and Node.js integrations can serve the same exported assets. Static hosting needs no database. The optional management server adds access control and publication workflows.
Start with the playground tour, explore workspace customization, or browse the API Reference tab.
Bring your own specification
Ready to use your own API? Install Doctopus to choose between static hosting, Spring Boot, Node.js and the optional management platform. The Documentation tab includes the complete installation walkthrough, framework integration guides, authoring reference and operational handbook.
This demo showcases a pre-release open source project. Visit the repository for source code and launch progress.