Introduction
This documentation is for the preview version of the Dev Portal. If you aren't part of the preview program, please refer to the current Dev Portal docs.
Welcome to the preview release of Zuplo's new Developer Portal. At Zuplo we believe every API should have beautiful and powerful API documentation. The new Developer Portal is what is powering this documentation site and is now available as a beta for anyone to try.
What is the Dev Portal?
The Developer Portal is a powerful tool that allows you to create and manage beautiful API documentation. It is built on top of the Zuplo platform and provides a seamless experience for developers to consume your APIs.
Why the new Dev Portal?
The new Developer Portal is rewritten from the ground up to provide a more customizable experience. It is easy to use out of the box, but also allows for advanced customization for those who want to take it to the next level. The new Developer Portal is built on top of Zudoku, which is a powerful static site generator that allows for advanced customization and theming. Zudoku is build on Vite which allows for fast builds and a great developer experience.
What Features are available?
The new Developer Portal is packed with features that make it easy to create and manage your API documentation. Some of the key features include:
- Markdown Documenation: Write your documentation in Markdown and have it automatically converted to HTML.
- API Documentation: Automatically generate API documentation from your OpenAPI specifications.
- API Explorer: Explore and test your API directly from the documentation.
- Custom Pages: Create custom pages for your documentation using Markdown, MDX, or even React.
- Custom Modules: Install custom modules to extend the functionality of your documentation.
- API Key Management: When using Zuplo's API Key management, you can manage your API keys directly from the documentation. (Coming soon)
- Build-in Analytics: End users can see how they are using the API, monitor usage of their API keys, and more right from inside the portal. (Coming soon)
How to get started?
The new Developer Portal is available as a beta for anyone to try. To get started, you will need to sign up for a Zuplo account and create a new project. Once you have created a new project, you can follow the migration guide to enable the new Developer Portal.
Soon you will be able to create a new project with the new Developer Portal enabled by default.
Build, Deploy, and Hosting
Zuplo manages the build, deploy, and hosting of your developer portal for you. Simply sign up for Zuplo, create a new project, and you will have a fully functioning developer portal in minutes. Zuplo handles all the hosting and deployment for you, so you can focus on building your API and documentation.
Feedback
We are constantly working to improve the Developer Portal and would love to hear your feedback. If you have any suggestions or feedback, please reach out to us by emailing support@zuplo.com.