Add General purpose API wrapper util #5534
Open
+448
−0
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.
PR Checklist
PR Structure
otherwise).
services/friendbot
, orall
ordoc
if the changes are broad or impact manypackages.
Thoroughness
.md
files, etc... affected by this change). Take a look in the
docs
folder for a given service,like this one.
Release planning
CHANGELOG.md
within the component folder structure. For example, if I changed horizon, then I updated (services/horizon/CHANGELOG.md. I add a new line item describing the change and reference to this PR. If I don't update a CHANGELOG, I acknowledge this PR's change may not be mentioned in future release notes.semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
This PR adds a general purpose API wrapper which could be used to call any API endpoint with given query params and headers.
There are two modules added:
Also updated httptest library to support mocking http request when we want to see multiple results on subsequent api calls. This is particularly helpful when we want to test whether API retries work as expected or not.
Why
This will be used in stellar-etl to invoke various APIs-retool, github etc to fetch data and store in bigquery for analytics.
Known limitations
I did not add support for pagination as we don't have a use case as of now. However, this util can be extended in future as needed.
Questions
I am not sure if this is right place to add this library. I am open to relocating it where it finds better fit.