Estimated reading time:
This feature is only available with a Kong Enterprise subscription.
The Kong Developer Portal (Dev Portal) provides a single source of truth for all developers to locate, access, and consume services. With intuitive content management for documentation, streamlined developer onboarding, and role-based access control (RBAC), Kong’s Developer Portal provides a comprehensive solution for creating and customizing a unified developer experience.
Before you begin
Make sure the Dev Portal is on. You should have enabled it for Kong Gateway during installation.
Enable the Dev Portal for a Workspace
This will expose the Dev Portal at
Once enabled for the workspace, a few new links will appear in the left menu. It may take a few seconds for the Settings page to populate.
You can learn more about personalization in the the Dev Portal documentation, including:
Access and Interact with the Development Portal
Go back to Dev Portal > Overview and open the link in a new tab, or open the Dev Portal directly using this URL:
You’ll see a list of available API catalogs. By default, Kong Enterprise provides httpbin.org and Swagger Petstore as examples.
Click on the httpbin.org entry to explore the API.
On the left side, tags for the API as configured by the spec are displayed for easy searching.
On the right, you can see the HTTP methods of the API. Clicking into each method shows its details, lets you test the method, and provides code snippets developers can use to leverage the method in their applications.
Test the GET method:
- Under HTTP Methods, click the GET method.
- Click Try it Out, then click Execute. Review the results of the response.
Publish a Spec to Development Portal
In this section, you’re going to add a new spec, the Kong Vitals API, to the Dev Portal catalog. The Kong Vitals API shows how Kong Gateway and connected APIs are performing.
In Kong Manager, navigate to Dev Portal > Editor and open the link in a new tab. The editor lets you customize the Dev Portal.
Click on New File + to add a new spec.
In the New File dialog, open the dropdown and select spec, then name the spec
Click on Create File.
The editor creates the file and prepares it for editing. Since you haven’t added any content to the file, the preview displays “Unable to render this definition”.
In another tab, open the Kong Vitals Admin API page to download the
vitalsSpec.yaml. Open it in your favorite text editor and copy the contents of the file.
In the Dev Portal editor, clear the contents of the editor, then paste the contents of
Click Save Changes. If done correctly, the preview should show the API now.
Visit the Dev Portal at
http://<admin-hostname>:8003/SecureWorkspace and notice the new spec published to the Dev Portal.
In this topic, you:
- Enabled the Kong Dev Portal on the workspace SecureWorkspace.
- Tested the httpbin
- Added a new spec for the Kong Vitals API to the Dev Portal catalog.