Hello World
Tyk is an open source Enterprise API Gateway, supporting REST, GraphQL, TCP and gRPC protocols.
Tyk Gateway is provided ‘Batteries-included’, with no feature lockout. Enabling your organization to control who accesses your APIs, when they access, and how they access it.
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.
Built from the ground up to be the fastest API gateway on the planet. It does not depend on a legacy proxy underneath. It has no 3rd party dependencies aside from Redis for distributed rate-limiting and token storage. Tyk Gateway can also be deployed as part of a larger Full Lifecycle API Management platform Tyk Self-Managed which also includes Management Control Plane, Dashboard GUI and Developer Portal.
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 OAS2/3 documents 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 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/Ignored 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 API's (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)
Get Started today with Tyk Gateway (standalone)
Install
- Docker (Recommended method)
- Kubernetes-Native
- Kubernetes-Helm
- Ansible
- Red Hat
- Ubuntu
- CentOS
- Compile from Source (see instructions below)
Compile from Source
git clone https://github.com/TykTechnologies/tyk
go build
Go version 1.12 is required to build master, the current development version. Tyk is officially supported on linux/amd64, linux/i386 and linux/arm64.
Tests are run against both Go versions 1.12, 1.13, 1.14 and 1.15, however at present, only Go 1.12 is officially supported. In order to run tests locally use the following command:
go test ./...
Note that tests require Redis to be running on the same machine (default port).
In order to write your own test pls use this guide https://github.com/TykTechnologies/tyk/blob/master/TESTING.md
For more information about contributing PRs and issues, see CONTRIBUTING.md.
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
All the documentation for Tyk Gateway and other OSS can be found at https://tyk.io/docs/tyk-oss-gateway/
- Tyk Community Board - Technical support from the Tyk Community
- Write a GitHub Issue - Feature requests & bug reports welcome
- Technical blog - Tyk announcements and updates
- Newsletters - Subscribe to our GraphQL & API newsletters
- If you are using Tyk give us a star ⭐️
Tyk is released under the MPL v2.0; please see LICENSE.md for a full version of the license.
