API Gateway & Reverse Proxy Addition #31
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Frontend to next js
Add cypress e2e (with cucumber) test framework
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds Tyk as an api gateway to the app, cementing the microservice architecture. Also removes the dependancy on the .env.production as tyk & the stubs both run on the same port.
By default, the services are run behind TYK (used as an API Gateway & Reverse Proxy). Tyk is configured in the tyk folder, where each api has a config file (eg tyk/apps/auth). Here we configure which requests to tyk we match to this api, where we forward them on to and any middleware that is applied.
To access TYK, the frontend/orchestration needs to use an API Key. This is set as
TYK_API_KEYin the .env for the frontend, and is set as a header on all requests to tyk. This means that all requests to our services are fully secured through auth, as requests can only get to the service via tyk, and the only way to get the api key is to send a request to the frontend/orchestration with a valid auth token.If Tyk is giving errors in the logs like
connect: connection refused, you may need to generate a new api key and place it in the env file for the frontend. To do this, use the cUrl command in the tyk folder, and paste the value of the "key" output as the api key.