Developer Portal
Developer Portal overview
The Zuplo Developer Portal gives your API consumers a place to read documentation, explore your API, and manage their API keys. It combines API reference documentation from your OpenAPI specifications with pages you write in Markdown, MDX, or React.
Zuplo builds, deploys, and hosts the portal. The portal uses Zudoku for content, configuration, and customization.
What you can do
Use the Developer Portal to:
- Generate API reference documentation from your OpenAPI specifications and let readers test requests in the API Explorer.
- Publish guides and custom pages in Markdown, MDX, or React.
- Let consumers manage their keys when you use Zuplo's API key management.
- Show subscription quota usage with the monetization usage dashboard.
- Customize the portal's theme, install modules, and use a custom domain.
Core concepts
The portal combines three parts:
| Part | Purpose |
|---|---|
| OpenAPI specifications | Describe the API operations shown in the reference and API Explorer. |
| Documentation pages | Provide guides and other content you write for your API consumers. |
| Configuration file | Set navigation, appearance, authentication, and other portal options. |
You can work on the portal locally to
preview content and configuration changes before deployment. Zuplo manages
hosting, and you can assign a custom domain
such as docs.example.com.
Next steps
- Build your first developer portal in the Zuplo Portal, then test an authenticated API request.
- Review the configuration file to set up your portal's content and navigation.
- Add a custom domain for your published portal.
For help with your developer portal, contact support@zuplo.com.
Last modified on