Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
      Docs Contribution Guidelines
      Want to help out, or found an issue in the docs and want to let us know?
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Konnect
  • Home icon
  • Kong Konnect
  • Getting Started
  • Add Documentation
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Add Product Documentation
  • Add an API Spec

Add Documentation

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 (.md) file. The contents of this file will be displayed as the introduction to your API in the Dev Portal.

  1. Write a description for your API in Markdown (.md).

    If you don’t have a file you can use for testing, copy the following text into a blank .md file:

     Here's a description with some **formatting**.
    
     Here's a bulleted list:
     * One
     * Two
     * Three
    
     You can [add relative links](/) and [absolute links](https://cloud.konghq.com).
    
     Try adding a codeblock for code snippets:
    
         This is a test
    
    
  2. In the api-product icon API Products, select a service.

  3. Select Documentation, upload your documentation, add a Page name, and an optional URL slug.
  4. 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.

  1. From the api-product icon API Products dashboard, select Product Version then Upload.

  2. Find the Version Spec section and click Upload Spec.

  3. 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.

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 a link.

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.

Private Dev Portal
Public Dev Portal
  1. Access the Dev Portal in one of the following ways:
    • Open dev-portal icon Dev Portal from the left side menu. From there, click the Portal URL.
    • Directly visit the default Dev Portal URL:
     https://{ORG_NAME}.portal.cloud.konghq.com/
    
  2. Click Sign Up and fill out the form to create a developer account.

    Remember, the Dev Portal does not share credentials with your Konnect account.

  3. As an admin, return to Konnect and approve the account:

    1. From the left side menu, click dev-portal icon Dev Portal. Then click Access Requests to open the Access Requests page, which displays all pending developer request.

    2. In the row for developer request you want to approve, click the icon and choose Approve from the context menu.

      The status is updated from Pending to Approved. The developer transfers from the pending Requests page Developers tab to the Developers page.

  4. Check your email for a confirmation link. Click the link, then log into the Dev Portal.

  5. Open the API product you published to check it out.
  1. Open dev-portal icon Dev Portal from the left side menu, then click Settings.

  2. In the Public Portal pane, toggle the switch to Enabled.

  3. Click Save.

  4. Access the Dev Portal in one of the following ways:
    • From the left navigation menu again, go to Dev Portal. From there, click the Portal URL.
    • Directly visit the default Dev Portal URL:
     https://{ORG_NAME}.portal.cloud.konghq.com/
    
  5. Open the service you published to check it out.

Customize your Dev Portal

You can customize the Dev Portal to make it your own. Let’s change up a couple of things:

  1. Return to Konnect. From the left side menu, open dev-portal icon Dev Portal, then Appearance.

  2. 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.

  3. Click Save to apply the changes.

  4. 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.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023