@mehdad67/apitogo
v0.1.32
Published
Framework for building high quality, interactive API documentation.
Downloads
765
Readme
APIToGo
API documentation should always be free.
Installation · Examples · Contributing · Motivation
📢 Attribution
This project is based on Zudoku, an open-source API documentation framework licensed under MIT. Modifications, branding, and extensions by APIToGo.
Introduction
APIToGo is a customizable API documentation framework for building high-quality developer experiences around OpenAPI (and future GraphQL support).
Built on top of Zudoku, with enhancements and branding tailored for APIToGo.
Because great API documentation frameworks should be:
🌍 Free & Open Source ✅ OpenAPI powered 🔩 Extensible with Plugins ⚡ Fast and developer-friendly 🔧 Easy to maintain
✨ Features
- 🚀 Generate documentation from single or multiple OpenAPI schemas
- 📄 Create MDX pages for custom documentation
- 🔐 Authentication via OpenID or OAuth2
- 🧪 Built-in API playground
- 🌑 Dark mode support
⚙️ Installation
⚡️ Quick start
npm create @lukoweb/apitogo@latest(You may later replace this with your own CLI if you build one)
🎓 Examples
- API documentation portals
- Developer portals with authentication
- Internal API documentation systems
🔧 Contributing & Community
Contributions are welcome. Please follow standard GitHub workflows.
🎯 Motivation
APIToGo builds on the solid foundation of Zudoku to provide a customizable and scalable API documentation solution.
License
This project is licensed under the MIT License.
- Original work: Zudoku (© Zuplo)
- Modifications: APIToGo
See the full LICENSE.
