Insomnia logo
  • Documentation
  • Download
  • Upgrade
    • Introduction to Insomnia
    • Install Insomnia
    • Send Your First Request
    • Import and Export Data
    • Environment Variables
    • Insomnia Workspaces
    • Insomnia Accounts
    • Forgotten Passwords
    • Insomnia Subscriptions
    • Insomnia Subscription Management
    • Requests
    • Responses
    • Request Collections
    • Request Timeouts
    • Chaining Requests
    • Post CSV Data
    • SOAP Requests
    • gRPC
    • WebSocket Support
    • Get Started with Documents
    • Design Documents
    • Linting
    • GraphQL for OpenAPI
    • Migrate from Designer
    • Unit Testing
    • Stress Testing
    • Sign into Insomnia Cloud
    • Sync Collections with Insomnia Cloud
    • Teams
    • End to End Data Encryption
    • Sync with Git
    • Key Security Features
    • Security Standards
    • Signup and Authentication
    • Analytics Collected
    • Authentication
    • Client Certificates
    • Generate Code Snippet
    • Cookie Management
    • Encoding
    • GraphQL Queries
    • Run in Insomnia Button
    • Key Maps
    • HTTP(S) Proxy
    • Insomnia Configuration File
    • Introduction to Plugins
    • Context Object Reference
    • Template Tags
    • Hooks and Actions
    • Custom Themes
    • FAQ
    • Application Data
    • SSL Validation
    • Password Recovery
    • Introduction to Inso CLI
    • Install Inso CLI
    • CLI Command Reference
      • inso generate config
      • inso run test
      • inso lint spec
      • inso export spec
      • inso script
      • OpenAPI Spec Reference
    • Configuration
    • Inso CLI on Docker
    • Continuous Integration
    • Publish API to Dev Portal
    • Kong Declarative Config (for decK)
    • Kong for Kubernetes

Kong Declarative Config (for decK)

Note: This feature is currently only available on Design Documents with OpenAPI 3.0.X and 3.1 specifications.

Insomnia creates a preformatted decK file when you add endpoints to a Document. You can do this through the UI, as explained below. Or by using the Inso CLI command inso generate config.

You can also upload a Declarative Config file directly to your Kong Gateway instance. Learn how from the Kong Docs Loading the Declarative Configuration File.

Get a Declarative Config File Through Insomnia

  1. Open a Document.
  2. Add an OpenAPI 3.0 Specification. If you have another Swagger version, use a tool like editor.swagger.io to convert to OpenAPI 3.0.
  3. Click on the arrow next to the Document name.
  4. In the dropdown menu, click Declarative Config.

Next to the Document name, click the arrow to access the dropdown menu and click Declarative Config

Authentication in Declarative Config

The generated Declarative Configuration file contains authentication plugin information. openid-connect, as seen in the example screenshot below, is only compatible with Kong Gateway Enterprise. Ensure you define authentication that’s compatible with your Kong Gateway instance.

See Security Plugins in the OpenAPI 2 Kong Declarative Config for a list of authentication types and their corresponding plugins.

In the generated file, you will see authentication plugins defined.

We use OpenAPI 2 Kong Declarative Config to generate the Declarative Config file.

Edit this page
Report an issue
    COMPANY
  • Insomnia
  • Blog
  • Changelog
  • Pricing
  • Careers
    PRODUCTS
  • Insomnia
  • Inso (CLI)
    RESOURCES
  • Sign In
  • Documentation
  • Support
    LEGAL
  • Privacy Policy
  • Terms & Conditions
© Kong Inc. 2021