Skip to main content

Getting started

License: Dual-license

API Gateway is an AWS service that allows you to create, publish, maintain, monitor, and secure APIs at any scale.

Why use EventCatalog with Amazon API Gateway?​

Using the EventCatalog Amazon API Gateway integration you can import your API Gateway specifications into EventCatalog.

This allows you to visualize your API's, their endpoints, and the messages they send and receive. You can map the endpoints to commands, events and queries in your catalog and assign these to services and domains and teams in your organization.

EventCatalog will also allow you to download and view your OpenAPI specifications in the catalog directly, download schemas for each endpoint and see the requests/responses for each endpoint.

Core Features​

The EventCatalog Amazon API Gateway plugin can provide you with many features:

  • ⭐️ Generate domains, services, channels and messages into your catalog
  • ⭐️ Import and map your API Gateway specifications into EventCatalog
  • ⭐️ Map API Gateway routes to commands, events and queries in your catalog
  • ⭐️ Add semantic meaning to your API Gateway routes
  • ⭐️ and more....

How it works​

Example

This plugin will download OpenAPI specifications from your API Gateway and import them into EventCatalog. The API Gateway integration will add custom EventCatalog extensions onto your OpenAPI specification and then use the OpenAPI plugin to import the specification into EventCatalog.

This will map your routes into commands, events and queries in your catalog and assign these to services and domains and teams in your organization.

Commercial and License​

This plugin is governed by a dual-license. To ensure the sustainability of the project.

You can get a 14 day trial license key to try the plugin out by going to EventCatalog Cloud.

After the trial you can purchase a license to continue using this plugin.

Have any questions? You can email us at hello@eventcatalog.dev.

License FAQ​

What is the license key for?​

The license key is required to use the Amazon API Gateway plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.

How do I get a license key?​

You can obtain a license key by visiting EventCatalog Cloud. Your organization can have a 14 day trial license key to try the plugin out.

Terms​

  • Usage: Any many catalogs as you like in your organization
  • Trial Period: 14 days free trial no credit card required
  • Support: Discord community support (extra for priority support)

After your trial period ends, you can purchase a full license through EventCatalog Cloud to continue using the plugin.

Issues​

If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators or join our Discord community to chat with the team and other users.