If you’re looking for deeper customization, you can use Markdown Components to customize any page and view your edits in real-time with side-by-side preview directly in our new Portal Editor experience. 

For those needing to follow strict branding guidelines, we offer custom CSS so you can integrate your brand’s style and highly polish the experience. 

Kong-engineered OpenAPI 3.x spec rendering (AsyncAPI support coming soon)

We can all agree this sort of API reference experience feels pretty outdated:

Unsatisfied with the UX and functionality of existing spec rendering tools, we built our own. Anywhere API specs are displayed, you can expect to see Kong’s spec renderer in action, including the new Dev Portal, Insomnia, Service Catalog, and our own Admin API documentation. We’re also rolling it out to the broader developer community as an open source web-app in the coming months. Stay tuned! 

In beta, we support OpenAPI 3.x spec rendering. API producers and owners can upload a spec file to automatically generate and publish the latest API documentation across one or more developer portals. With built-in “Try it” capabilities in the UI, API consumers can test functionality directly within the browser, or in Insomnia, so they can quickly understand and get to the value of an API — in other words, adopt it properly — faster.

Our spec renderer will expand beyond synchronous protocols to support AsyncAPI, enabling API producers to publish both types seamlessly. This will ensure a unified tool for API rendering and a streamlined consumer DevEx (developer experience) with comprehensive, centralized documentation.  

Elevated DevEx for API owners and producers

We’ve significantly simplified the API publishing flow, so you can simply upload a spec file to create their API entity:

You can then select preferred visibility (public/private) and authentication settings for publishing. The API will populate in the right portal(s) with modern, up-to-date, and interactive API reference: 

Once an API entity is created in Konnect, you can:

• Add/edit API documentation
• Edit the API specification
• Publish/unpublish the API to one or more portals and edit visibility and authentication strategy settings, all in one place in a few clicks
• Link the API entity to an existing Kong Gateway service (for Konnect and Konnect Plus users only)

API owners can also rest assured that their published API will be available to the right audience in a secure manner. This includes the ability to:

• Enable self-service application registration and auto-approval workflows with key-based authentication 
• Set the visibility of Pages and APIs to public (anyone on the internet with the portal link can view the API) or private (only authenticated developers can view the Dev Portal)
• Control the visibility of landing pages and APIs by making them public — accessible to anyone on the internet with the link — or requiring signup to access specific pages, APIs, or retrieve API keys

After publishing their API to a portal(s), owners/producers can evaluate and enhance their API’s usability and performance by leveraging key metrics accessible from the built-in Analytics dashboard in Konnect Dev Portal.

See how the new Konnect Dev Portal drives API discovery and adoption

We’re excited for you to try out the new portal setup, API publishing, and customization experience.  

To test it out, log in or register for Konnect Plus and launch your first Dev Portal in only a few clicks today! 

If you’re a current Konnect customer interested in using the Dev Portal, please reach out to your Kong Customer Success Manager to help you get started! We look forward to seeing what you build with discoverable, well-documented, reusable APIs.