This is a Java client for the Tyk API Gateway available on GitHub. This project fully implements the Tyk v1.8 REST API. This client has not been fully tested and is still in development so please report any issues or problems. The goal of this project is to provide a client for Tyk to provide integration between Tyk and Java applications.
The REST API client is provided by Retrofit.
All requests follow the general pattern show below:
TykClient client = new TykClient("http://endpoint", "tyk-authorization-key");
// Create a request.
CreateKeyRequest request = new CreateKeyRequest();
// Send a request and get a response.
CreateKeyResponse response = client.createApiKey(request);
// Get what you need from the response.
String newApiKey = response.getKey();
The TykClient has a separate constructor that takes a read timeout and connection timeout in seconds if the default 60 second timeout is unacceptable.
There is a TykClientIT class that will execute against a Tyk installation. Prior to running the tests in this class provide your Tyk installation URL, authorization key, and a valid API ID in the variables in this class.
Contributions in all areas (development, testing, documentation) are very much welcomed. Please fork and submit pull requests.
This project is licensed under the Apache 2.0 license.
This project is maintained by Mountain Fog and we can be contacted via email at [email protected].