Deploying APIs in API Gateway vs Choreo Connect

API Deploying is the process of making the API available for invocation. WSO2 API Manager comes with two gateway choices, the traditional API Gateway and the lightweight Choreo Connect.

Choreo Connect is focused on providing a convenient experience for developers through developer-centric API management. This is where APIs can be managed by the use of OpenAPI definitions and it is the most common way of creating/defining APIs in a Choreo Connect environment. This method allows developers to define Choreo Connect API endpoints using standard OpenAPI definitions. They only have to copy an already defined OpenAPI definition of a valid REST endpoint to the Choreo Connect project. Choreo Connect will parse the resources and different attributes defined in the OpenAPIs definition and generate the required gateway services. These services can then be built and deployed into different gateway environments.

Choreo Connect vs API Gateway

Choreo Connect and the "traditional" API Gateway can be compared in different aspects as below.  The decision to select either of the gateways is highly dependent on the architecture, design, and deployment. Both gateways mostly have similar features and functionality, but works differently in order to cater for the purpose it was designed to serve.

Design and deployment comparison

Design/ Deployment Choreo Connect API Gateway
Architecture Designed for microservices Designed for monolith
Horizontal Scaling Scales independently as the runtime does not have a direct dependency on other components. Security and throttling validations are done within Choreo Connect. Scaling can be done with other components. For example, the traffic manager (one node per dedicated cluster of gateway nodes ) and key manager can be scaled along with the gateway.
Deployment distribution Decentralized Centralized
Runtime footprint Lightweight and can run on computers with low performance. Designed to run on high performing computers with high load (memory and high CPUs )
Isolated lockdown environments Designed to work in a network isolated environment Limited functionalities(affect on throttling/ analytics)
Cloud ready Yes Yes
Automated API CI/CD flows Supported with CLI tools Supported with CLI tools
Update APIs Immutable gateways. Rebuild the gateway upon updating the API Mutable gateway, updating APIs supported

Security Comparison

API Gateway and Choreo Connect both support different security mechanisms.

Security Mechanism Choreo Connect API Gateway
Oauth2 opaque tokens (tick) (tick)
Oauth2 self-contained tokens (tick) (tick)
Mutual SSL (tick) (tick)
Basic Auth Config based supported, can not plug user stores (tick)
API Keys (tick) (tick)

Feature Comparison

Feature Choreo Connect API Gateway
SOAP backends (tick) (tick)
REST APIs (tick) (tick)
JMS backends (error) (tick)
GraphQL APIs (error) (tick)
GRPC Services (tick) (error)
Web socket APIs (error) (tick)
Custom mediation/transformation (tick) (tick)
Advance throttling (header, IP, query param, jwt claims) (tick) (tick)
Advance throttling (based on bandwidth) (error) (tick)
Schema validation (tick) (tick)
JWT revocation (tick) (tick)
Per resource Endpoints (tick) (error)
Top