Hi everyone,
I’ve created a working Tyk demo that I’d love the community to contribute to: GitHub - jonathanviber/tyk-oas-demo
Why I built this:
I couldn’t find a single complete example of a Tyk deployment example using OAS files. After hours of struggling, I want to make an example to get started faster, especially since OAS is now the preferred way to configure endpoints.
What’s included:
- Working Docker Compose setup with Tyk Gateway, Redis and 2x basic backend services
- OAS-based API definitions in a local file (GitOps-ready)
- Common production infrastructure:
- OTEL/prometheus metrics on a /metrics endpoint
- Health checks on a /health endpoint
- Admin endpoints on separate port (5555)
Performance Optimization:
I saw a performance test comparing Tyk to Kong. Initial Tyk performance wasn’t optimal with their config, so the Tyk team stepped in later to suggest improvements— Tyk is fast so I want this example to perform optimally out-of-the-box.
Current status:
The basic setup works, but there are still some issues and missing features documented in the readme on Github
Looking for:
Contributors to help fix issues, add missing features, or improve the implementation. This could be a great reference for anyone wanting to get started that is struggling with the existing samples.
Pull requests welcome! Let’s make this great!