The Dev Portal is an API catalog that lets you document your Konnect API products
and share them with your developers. Developers can use the Dev Portal to
locate, access, consume, and register applications against the products.
This guide walks you through associating API specs and product documentation with your API products, and viewing any published content, and Dev Portal specific customization options.
Add Product Documentation
You can provide extended descriptions of your Konnect API products with a Markdown (
The contents of this file will be displayed as the introduction to your API in the Dev Portal.
Write a description for your API in Markdown (
If you don’t have a file you can use for testing, copy the following text
into a blank
Here's a description with some **formatting**.
Here's a bulleted list:
You can [add relative links](/) and [absolute links](https://cloud.konghq.com).
Try adding a codeblock for code snippets:
This is a test
In the API Products, select a service.
- Select Documentation, upload your documentation, add a Page name, and an optional URL slug.
- Click Save.
Add an API Spec
Every version can have one OpenAPI spec associated with it, in JSON or YAML format.
If you have a spec, use it in the following steps. Otherwise, you can
use the sample Analytics spec for testing.
From the API Products dashboard, select Product Version then Upload.
Find the Version Spec section and click Upload Spec.
Select a spec file to upload.
The spec must be in YAML or JSON format. To test this functionality, you
can use vitalsSpec.yaml as a sample spec.
This OpenAPI spec will be shown under the version name when this service is
published to the Dev Portal.
Publish API Product to the Dev Portal
To view an API Product’s documentation alongside its dynamic API reference (based on the API specification),
navigate to API Products and publish your API product along with its API version.
- In the API Products section, select your API Product. Then, click Actions and select Publish to portal.
- From the left-side navigation panel, select Product Version and click on the version you created previously.
On the version’s homepage, change the Status to Published.
View the published content on Dev Portal
In this section, you can take one of two paths: keep the Dev Portal private
and require a login, or switch it to public, making it visible to anyone with
If you choose to make the Dev Portal public, application registration
will not be available.
Note: The Dev Portal is a separate site that requires its own credentials.
You can’t use your Konnect credentials to log in here.
Customize your Dev Portal
You can customize the Dev Portal to make it your own.
Let’s change up a couple of things:
Return to Konnect. From the left side menu, open
Dev Portal, then Appearance.
Try out a couple of customization options - whatever you like.
- Choose a preset theme and adjust it to your needs
- Set some home page text
- Upload header, logo, or favicon images
- Play around with the colours and fonts of your site
You could also add a custom domain,
if you have one you want to use.
Click Save to apply the changes.
Switch back to the Dev Portal to see your changes live.
Summary and next steps
In this topic, you:
- Logged into the Dev Portal to check out the API product documentation live
- Customized the Dev Portal
Next, register an application against the API product.