Go Plugins Quickstart

Last updated: 1 minute read.

This section takes you through the process of running and building a quickstart Go plugin, included within Tyk’s getting started repository. Go plugins are the recommended plugin type and suitable for most use cases.

Expected outcome

At the end of this process you should have a Tyk Gateway or Tyk Self-Managed environment running locally, with a simple Go plugin executing on each API request. For each reponse to an API request the example plugin will inject a Foo header, with a value of Bar.

Prerequisites

  • Docker
  • Docker-compose
  • Tyk license (if using Self-Managed Tyk, which will make the process easier via UI)
  • Make
  • OSX (Intel) -> Not a prerequisite, though these steps are tested on OSX Intel/ARM

Before you begin

Please clone the getting started respository.

git clone https://github.com/TykTechnologies/custom-go-plugin
cd custom-go-plugin

Choose your environment

Next Steps

Try our advanced Go Plugin tutorials.