Automate your API catalog with Dev Portal

This is a Konnect tutorial and requires a Konnect personal access token.

1. Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.

2. Export your token to an environment variable:

    export KONNECT_TOKEN='YOUR_KONNECT_PAT'
   

3. Run the quickstart script to automatically provision a Control Plane and Data Plane, and configure your environment:

    curl -Ls https://get.konghq.com/quickstart | bash -s -- -k $KONNECT_TOKEN --deck-output
   

   This sets up a Konnect Control Plane named quickstart, provisions a local Data Plane, and prints out the following environment variable exports:

    export DECK_KONNECT_TOKEN=$KONNECT_TOKEN
    export DECK_KONNECT_CONTROL_PLANE_NAME=quickstart
    export KONNECT_CONTROL_PLANE_URL=https://us.api.konghq.com
    export KONNECT_PROXY_URL='http://localhost:8000'
   

   Copy and paste these into your terminal to configure your session.

This tutorial requires Kong Gateway Enterprise. If you don’t have Kong Gateway set up yet, you can use the quickstart script with an enterprise license to get an instance of Kong Gateway running almost instantly.

1. Export your license to an environment variable:

    export KONG_LICENSE_DATA='LICENSE-CONTENTS-GO-HERE'
   

2. Run the quickstart script:

    curl -Ls https://get.konghq.com/quickstart | bash -s -- -e KONG_LICENSE_DATA 
   

   Once Kong Gateway is ready, you will see the following message:

    Kong Gateway Ready
   

decK is a CLI tool for managing Kong Gateway declaratively with state files. To complete this tutorial you will first need to install decK.

For this tutorial, you’ll need Kong Gateway entities, like Gateway Services and Routes, pre-configured. These entities are essential for Kong Gateway to function but installing them isn’t the focus of this guide. Follow these steps to pre-configure them:

1. Run the following command:

   echo '
   _format_version: "3.0"
   services:
     - name: example-service
       url: http://httpbin.konghq.com/anything
   routes:
     - name: example-route
       paths:
       - "/anything"
       service:
         name: example-service
   ' | deck gateway apply -
   

To learn more about entities, you can read our entities documentation.

For this tutorial, you’ll need a Dev Portal pre-configured. These settings are essential for Dev Portal to function, but configuring them isn’t the focus of this guide. If you don’t have these settings already configured, follow these steps to pre-configure them:

1. Create a Dev Portal:

   curl -X POST "$KONNECT_CONTROL_PLANE_URL/v3/portals" \
        -H "Accept: application/json"\
        -H "Content-Type: application/json"\
        -H "Authorization: Bearer $DECK_KONNECT_TOKEN" \
        --json '{
          "name": "MyDevPortal",
          "authentication_enabled": false,
          "auto_approve_applications": false,
          "auto_approve_developers": false,
          "default_api_visibility": "public",
          "default_page_visibility": "public"
        }'
   

2. Export your Dev Portal ID and URL from the output:

   export PORTAL_ID='YOUR-DEV-PORTAL-ID'
   export PORTAL_URL='YOUR-DEV-PORTAL-DOMAIN'
   

3. Create a page in your Dev Portal so published APIs will display:

   curl -X POST "$KONNECT_CONTROL_PLANE_URL/v3/portals/$PORTAL_ID/pages" \
        -H "Accept: application/json"\
        -H "Content-Type: application/json"\
        -H "Authorization: Bearer $DECK_KONNECT_TOKEN" \
        --json '{
          "title": "My Page",
          "slug": "/apis",
          "description": "A custom page about developer portals",
          "visibility": "public",
          "status": "published",
          "content": "# Welcome to My Dev Portal\nExplore the available APIs below:\n::apis-list\n---\npersist-page-number: true\ncta-text: \"View APIs\"\n---\n"
        }'