Skip to main content

Getting started

View as Markdown
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 requires an EventCatalog Scale license key to be used.

You can get a 30-day trial Scale license key by going to EventCatalog Cloud.

After the trial, you can continue using this plugin with EventCatalog Scale.

See pricing for more information.

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

License FAQ​

What is the license key for?​

The EventCatalog Scale 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 an EventCatalog Scale license key?​

You can obtain an EventCatalog Scale license key by visiting EventCatalog Cloud. Your organization can start with a 30-day trial.

Terms​

  • Trial Period: 30-day free trial no credit card required
  • Support: Discord community support (extra for priority support)

After your trial period ends, you can continue with EventCatalog Scale through EventCatalog Cloud.

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.