Skip to content
Kong Logo | Kong Docs Logo
search
  • Docs
    • Explore the API Specs
      View all API Specs View all API Specs View all API Specs arrow image
    • Documentation
      API Specs
      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
  • 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 Gateway
2.7.x
  • Home icon
  • Kong Gateway
  • Get Started
  • Comprehensive
  • Publish, Locate, and Consume Services
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
  • 3.5.x (latest)
  • 3.4.x
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Before you begin
  • Enable the Dev Portal for a Workspace
  • Access and Interact with the Dev Portal
  • Publish a Spec to Dev Portal
  • Summary
You are browsing documentation for an outdated version. See the latest documentation here.

Publish, Locate, and Consume Services

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), the Dev 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 during installation.

Enable the Dev Portal for a Workspace

Using Kong Manager
Using the Admin API
  1. In Kong Manager, open the Workspaces tab and open your workspace (for example, SecureWorkspace).

  2. Scroll down in the sidebar, then click the Overview link under the Dev Portal section.

  3. Click Enable Developer Portal and refresh the browser page.

cURL
HTTPie
curl -X PATCH http://localhost:8001/workspaces/SecureWorkspace \
  --data config.portal=true
http -f PATCH http://localhost:8001/workspaces/SecureWorkspace \
  config.portal=true

This will expose the Dev Portal at http://localhost:8003/SecureWorkspace.

After the Dev Portal is enabled for the Workspace, a few new links appear in the left navigation menu. It may take a few seconds for the Settings page to populate.

You can learn more about personalization in the Dev Portal documentation, including:

  • Customizing the look and feel of the site and editor
  • Managing access
  • Configuring the Dev Portal

Access and Interact with the Dev Portal

  1. Go back to Dev Portal > Overview and open the link in a new tab, or open the Dev Portal directly using this URL: http://localhost:8003/SecureWorkspace.

    You’ll see a list of available API catalogs. By default, httpbin.org and Swagger Petstore appear as examples.

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

  3. Test the GET method:

    1. Under HTTP Methods, click the GET method.
    2. Click Try it Out, then click Execute. Review the results of the response.

Publish a Spec to Dev 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.

  1. In Kong Manager, navigate to Dev Portal > Editor and open the link in a new tab. The editor lets you customize the Dev Portal.

  2. Click on New File + to add a new spec.

  3. In the New File dialog, open the dropdown and select spec, then name the spec vitals_spec.yaml.

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

  5. In another tab, open the Kong Vitals Overview page to download the vitalsSpec.yaml. Open it in your favorite text editor and copy the contents of the file.

  6. In the Dev Portal editor, clear the contents of the editor, then paste the contents of vitalsSpec.yaml.

  7. Click Save Changes. If done correctly, the preview should show the API now.

  8. View the Dev Portal at http://localhost:8003/SecureWorkspace and notice the new spec published to the Dev Portal.

Summary

In this topic, you:

  • Enabled the Dev Portal on the Workspace SecureWorkspace.
  • Tested the httpbin GET method.
  • Added a new spec for the Kong Vitals API to the Dev Portal catalog.
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
    Powering the API world

    Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller.

    • Products
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • Product Updates
      • Get Started
    • Documentation
      • Kong Konnect Docs
      • Kong Gateway Docs
      • Kong Gateway Enterprise Docs
      • Kong Mesh Docs
      • Kong Insomnia Docs
      • Kong Konnect Plugin Hub
    • Open Source
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kong Community
    • Company
      • About Kong
      • Customers
      • Careers
      • Press
      • Events
      • Contact
  • Terms• Privacy• Trust and Compliance
© Kong Inc. 2023