Documentation | Forum | Blog | About
Tyk API Gateway
Tyk Gateway is the cloud-native, open source, enterprise-ready API Gateway supporting REST, GraphQL, TCP and gRPC protocols.
Built from the ground up, as the fastest API Gateway on the planet since 2014.
Tyk Gateway is provided ‘Batteries-included’, with no feature lockout. Enabling your organization to rate limit, auth, gather analytics, apply microservice patterns and more with ease.
Tyk runs natively on Kubernetes, if you prefer, thanks to the Tyk Kubernetes Operator
|
|
|
Get Started
We’ll install Tyk, add auth, analytics, quotas and rate limiting to your API in under 5 minutes.
We recommend Tyk Gateway Docker as the quickest way to get started now. Later, you can move to one of our other supported distributions if you prefer.
Step 1 - Clone the docker-compose repository
git clone https://github.com/TykTechnologies/tyk-gateway-docker
Step 2 - Change to the new directory
cd tyk-gateway-docker
Step 3 - Deploy Tyk Gateway and Redis
docker-compose up
You can run this in detach mode using the -d flag: docker-compose up -d
Congratulations, you’re done!
Your Tyk Gateway is now configured and ready to use. Confirm this by checking against the ‘hello’ endpoint:
curl localhost:8080/hello
Output:
{"status": "pass", "version": "v3.2.1", "description": "Tyk GW"}
Next, visit adding your first API to Tyk and follow the Open Source instructions.
Other Installations are available:
Open Source API Gateway Features
Use any protocol: REST, SOAP, GraphQL, gRPC, and TCP.
Industry Standard Authentication: OIDC, JWT, bearer Tokens, Basic Auth, Client Certificates and more.
Open API Standards: Import your Swagger and OpenAPI Documents (OAS 2.X and OAS 3.0.1) to scaffold APIs in Tyk.
Ultra performant: Low latency, and thousands of rps with just a single CPU, horizontally and vertically scalable.
Content mediation: Transform all the things, from request or response headers to converting between SOAP and GraphQL.
Extensible Plugin Architecture: Customize Tyk’s middleware chain by writing plugins in your language of choice - from Python to Javascript to Go, or any language which supports gRPC.
Rate Limiting & Quotas: Protect your upstreams from becoming overloaded and/or apply limits for each consumer.
API Versioning - API Versions can be easily set and sunset (deprecated) at a specific time and date.
Granular Access Control - Grant access to one or more APIs on a per version and operation basis.
Blocklist/Allowlist/Ignore endpoint access - Enforce strict security models on a version-by-version basis to your access points.
Analytics logging - Record detailed usage data on who is using your APIs (raw data only)
CORS - Enable CORS for certain APIs so users can make browser-based requests
Webhooks - Trigger webhooks against events such as Quota Violations and Authentication failures
IP AllowListing - Block access to non-trusted IP addresses for more secure interactions
Hitless reloads - Tyk configurations can be altered dynamically and the service restarted without affecting any active request
Kubernetes native declar