Swagger refactor to isolate v1 & v2 APIs #1016
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
The mixed mode aspect of DataAPI is problematic for swagger and violates many swagger assumptions. Swagger assumes 1 binary with 1 router that serves all API versions, but with DataAPI v2 the v1 API are not available, and each server mode instatiates its own router. To isolate v1/v2 API we define separate swagger instances/packages. The real problematic piece is how swagger dynamically finds handler endpoints. The only way to get it to ignore v1 or v2 when build a specific version is to define handler annotations in a subdir and generate swagger from that directory.
pschork
force-pushed
the
pschork/dataapi_v2_swagger
branch
from
9a4b8bf to
94df1f0
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.
The mixed mode aspect of DataAPI is problematic for swagger and violates many swagger assumptions. Swagger assumes 1 binary with 1 router that serves all API versions, but with DataAPI v2 the v1 API are not available, and each server mode instatiates its own router. To isolate v1/v2 API we define separate swagger instances/packages. The real problematic piece is how swagger dynamically finds handler endpoints. The only way to get it to ignore v1 or v2 when building a specific version was to move handler annotations in a versioned subdir and generate swagger from that directory.
Why are these changes needed?
Checks