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
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • 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
  • Productize a Service
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Prerequisites
  • Create an API product
    • Create an API product version
  • Publish an API product
  • Next steps

Productize a Service

Using API Products, you can create and manage API products to productize your services. Each API product consists of at least one API product version, and each API product version is connected to a Gateway service. Creating API products is the first step in making your APIs and their documentation available to developers.

Konnect service diagram

This guide will walk you through creating an API product and productizing it by deploying it to the Dev Portal.

Prerequisites

If you’re following the Konnect quickstart guide, make sure you have followed the steps in Proxy and test a service.

Create an API product

Let’s set up your first API product and API product version, by clicking api-product icon API Products from the Konnect side navigation bar.

  1. Select API Product from the API products dashboard to add a new API product.

  2. Create a new name for your API product, and enter an optional Description and any labels that you want to associate with the product, then press create.

You will be greeted by the dashboard for the API product that you just created. You can use this dashboard to manage an API product. You can read more about this dashboard on the API products overview page

Create an API product version

After creating a new API product, you can attach an API product version to it.

  1. From the API product builder, select Product Versions, then select New Version.

  2. Enter a version name. For example v1. A version name can be any string containing letters, numbers, or characters; for example, 1.0.0, v1, or version#1. A service can have multiple versions.
  3. Click Create to finish creating the product version and be taken to the Product Versions dashboard.

After creating the new version, you will see Link with a Gateway Service as an option in the Product Version Dashboard. You can link a Gateway service to your product version to enable features like App registration.

  1. Select Link with a Gateway Service.

    Choose the control plane and Gateway Service to deploy this API product version to. This lets you deploy your service across data plane nodes associated with the control plane.

  2. Click Save.

Publish an API product

API products can be published to the Dev Portal. To publish your new API product navigate to the api-product icon API Products and follow these steps:

  1. Select the API product that you created in the previous step.
  2. Navigate to the Actions menu, then select publish.

Your API product is now consumable by developers from the Dev Portal.

Next steps

In this section, you added an API product, linked a Gateway service via an API product version to it, and published it to the Dev Portal.

Next, add documentation and test out the Dev Portal from the perspective of a developer.

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