tyk README

The project's README from github.com/TykTechnologies/tyk. As one markdown file: README.md.

tyk-github-header License: MPL 2.0 FOSSA Status

GitHub Latest Release GitHub Release Date Docker Pulls GitHub Workflow Status (with event) Go Report Card

GitHub commit activity GitHub Repo Stars GitHub Repo Forks X twitter Follow

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


Everything you need to manage APIs. Follow the simple Get Started guide below 👇
The Enterprise API Management platform: Management Control Plane, Dashboard GUI & Developer Portal.
Install Tyk Self Managed
The Enterprise API Management platform SaaS: Management Control Plane, Dashboard GUI & Developer Portal.
Deploy Tyk Cloud

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:

  1. Docker
  2. Kubernetes-Native
  3. Kubernetes-Helm
  4. Ansible
  5. Red Hat
  6. Ubuntu
  7. CentOS
  8. Compile Tyk from Source

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 declarative API: using Open Source Tyk Operator (more info in OSS section) OpenSourceAPIGateway-Diagram

Tyk Technologies uses the same API Gateway for all it’s applications. Protecting, securing, and processing APIs for thousands of organizations and businesses around the world. Ideal for Open Banking, building software in the clouds as well as exposing APIs to teams, partners & consumers.

Tyk OSS Integrations

Tyk Technologies maintains other Open Source Software which can be used in conjunction with Tyk API Gateway:

Tyk Pump - Pluggable analytics purger to move Analytics generated by your Tyk nodes to any back-end.

Tyk Operator - Brings API Management capabilities to Kubernetes. Configure Ingress, APIs, Security Policies, Authentication, Authorization, Mediation and more - all using Custom Resources and Kubernetes Native primitives

Tyk Identity Broker - Tyk Authentication Proxy for third-party login

Tyk Sync - Command line tool and library to manage and synchronise a Tyk installation with your version control system (VCS).

Tyk Mserv - Asset Server and gRPC host

Documentation

All the documentation for Tyk Gateway and other OSS-related topics can be found at https://tyk.io/docs/tyk-oss-gateway/

Community

Licensing

Tyk is dual-licensed:

  1. Open Source License: The code in the root directory and all subdirectories except the 'ee' folder is released under the MPL v2.0. Please see LICENSE for the full version of the open source license.

  2. Commercial License: The code in the 'ee' folder is subject to a commercial license. For more information about obtaining a commercial license, please contact our sales team at [email protected].

Compiling Tyk Gateway

Compile from Source

git clone https://github.com/TykTechnologies/tyk
go build

Go version 1.22 is required to build master, the current development version. Tyk is officially supported on Linux/amd64, Linux/i386 and Linux/arm64.

To run tests locally use the following command:

go test ./...

Note that tests require Redis to be running on the same machine (default port).

To write your own test please use this guide https://github.com/TykTechnologies/tyk/blob/master/TESTING.md

Contributing

For more information about contributing PRs and issues, see CONTRIBUTING.md.

—

tyk (TykTechnologies/tyk)

Searching Database…

10.9K ·GitHub
Tyk
What is this?Tyk is an open-source, cloud-native API Gateway that lets you manage REST, GraphQL, TCP, gRPC and MCP (Model Context Protocol) traffic in one place, adding authentication, rate limiting, quotas and analytics to your APIs.
Is this a library I import, or a standalone service I deploy?It is a standalone gateway service you deploy in front of your APIs (via Docker, Kubernetes, Helm, Ansible or native packages), not a library you import into application code.
How do I get Tyk running?Clone the docker-compose repo, change into the new directory, and run 'docker-compose up -d' to deploy Tyk Gateway together with Redis in under 5 minutes. Kubernetes-Native, Helm, Ansible, Red Hat, Ubuntu, CentOS and compiling from source are also supported.
Do I need Redis to run Tyk?Yes, Tyk relies on Redis for state and analytics, and the Docker Compose quickstart deploys Redis alongside the Gateway. Compiling from source additionally requires Go 1.22.
Are all of Tyk's features free and open source?Most of it is: code outside the 'ee' folder is MPL v2.0 licensed open source, but the 'ee' (Enterprise Edition) folder is under a separate commercial license, so some features require a paid license.
Which OS can I run the compiled Gateway binary on?Tyk is officially supported on Linux/amd64, Linux/i386 and Linux/arm64 when compiled from source; the Docker and Kubernetes distributions let you run it without worrying about the underlying OS.
What other open-source tools does Tyk Technologies maintain?Alongside the Gateway, Tyk maintains Tyk Pump (analytics purger), Tyk Operator (Kubernetes API management via CRDs), Tyk Identity Broker (auth proxy for third-party login), Tyk Sync (CLI to sync config with version control) and Tyk Mserv (asset/gRPC host).
What languages can I write Gateway plugins in?Tyk's extensible plugin architecture lets you write custom middleware in Python, JavaScript, Go, or any language that supports gRPC.
Does Tyk work natively with Kubernetes?Yes, the open-source Tyk Operator lets you manage Ingress, APIs, security policies and authentication using Kubernetes Custom Resources, so Tyk can run fully declaratively on K8s.
How fast is Tyk compared to other gateways?Tyk bills itself as the fastest API Gateway since 2014, delivering low latency and thousands of requests per second on a single CPU while scaling both horizontally and vertically.
What are similar projects?kong, apisix, bifrost, casdoor, busbar, evenfire, ccx, gateway
Which topics is it in?api-management, llm-ops, mcp-gateway, rate-limiting, ai-gateway, k8s, llm-gateway, oidc, api-gateway, jwt, webhooks, grpc
Creator
TykTechnologies
Size
262 MB
Stars
10.9K
Updated
CommitOct 15Releasev5.15.1Oct 02
Age
12y
Commits · 90 Days