API: Refactor REST API to enable re-use of functionality. #1471
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
hsanjuan
changed the title
hsanjuan
force-pushed
the
feat/refactor-api
branch
4 times, most recently
from
0a25ad7
to
4977531
Compare
hsanjuan
commented
Sep 16, 2021
This is a preparatory PR to add additional APIs (Pinning Service API) easily to cluster. Instead of copy-pasting most of what the REST API does, I have refactored so that the whole configuration, routing and request-handling utilities can be re-used. The worst part has been to divide the test between tests that test core (common.API) functionality and tests that test specific REST API endpoint functionality. I could not get away without an additional common/test package to provide functions that are used from both places. This is a side effect of testing both http and libp2p endpoints for every request etc.
hsanjuan
force-pushed
the
feat/refactor-api
branch
from
4977531
to
63972f2
Compare
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 is a preparatory PR to add additional APIs (Pinning Service API) easily
to cluster.
Instead of copy-pasting most of what the REST API does, I have refactored so
that the whole configuration, routing and request-handling utilities can be
re-used.
The worst part has been to divide the test between tests that test core
(common.API) functionality and tests that test specific REST API endpoint
functionality. I could not get away without an additional common/test package
to provide functions that are used from both places. This is a side effect of
testing both http and libp2p endpoints for every request etc.