Cloudharness Dev Portal

Welcome to Better API Documentation

Welcome to your new developer portal that makes sense. 🎉

This is your new developer portal, built with "Zudoku by Zuplo" and designed to elevate your API documentation experience. We've streamlined the setup process so you can focus on what matters most: creating exceptional developer experiences.

Think of this as your API's professional showcase—presenting your endpoints and documentation in the best possible light. Whether you're launching innovative new features or improving existing services, this portal provides the foundation for clear, accessible, and engaging developer documentation.

Let's explore what we've configured for you and how you can customize it to perfectly match your needs.

Let's Review Your Configuration

The developer portal is configured in the zudoku.config.tsx file. We've created a starter configuration to get you up and running quickly. Let's walk you through everything we've set up so you know how to customize it:

  1. Change the Basics

    First, you may want to change the title and banner we've put in place. These are part of the page section in your configuration.

    Have a company logo? Learn how you can add your logo in our documentation.

    Code
     
    {
 // ...
 "page": {
   "title": "My Developer Portal",
   "banner": {
     "message": (
       <div className="w-full text-center">
         <strong>Congrats!</strong> 🙌 You just created your first developer
         portal.
       </div>
     ),
     "color": "info",
     "dismissible": true,
   }
}

  2. API Reference

    Your API Reference is generated from your Zuplo OpenAPI file in ../routes.oas.json—you can add other APIs whenever you need them. Improve your documentation by adding more details to the OpenAPI file.

    Code
     
    {
  // ...
  "apis": {
    "type": "file",
    "input": "../config/routes.oas.json",
    "navigationId": "api"
  }
}

  3. Authentication & Login

    We've configured your project to use Auth0 as an authentication provider with our demo account. We support many authentication providers—check the documentation on how to configure each one.

    You must change the authentication provider before taking this to production. Using our demo provider is not secure for production use.

    Code
     
    {
  // ...
  "authentication": {
    "type": "auth0",
    "domain": "auth.zuplo.io",
    "clientId": "kWQs12Q9Og4w6zzI82qJSa3klN1sMtvz",
    "audience": "https://api.example.com/"
  }
}

  4. API Keys

    We've enabled API Keys on your developer portal. This connects to the API Key Service in Zuplo. To add API Keys for your users, create a consumer with the matching email address in Services => API Key Service in Zuplo, or create a Consumer using the Zuplo API.

    Code
     
    {
  // ...
  "apiKeys": {
    "enabled": true
  }
}

Make It Yours

You can customize the look and feel of your documentation site by modifying the theme section in zudoku.config.tsx. Why not try changing the primary color of your site?

Code
 
{
  // ...
  "theme": {
    "light": {
      "primary": "316 100% 50%",
      "primaryForeground": "360 100% 100%"
    },
    "dark": {
      "primary": "316 100% 50%",
      "primaryForeground": "360 100% 100%"
    }
  }
  // ...
}

We have extensive customization options available. From colors to fonts and borders, find the full list of options in our documentation.

Last modified on
Welcome to Our Documentation