This repository has been archived by the owner on Jan 11, 2021. It is now read-only.
Add support for making API paths relative to the specified api_path setting #433
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.
I ran into an issue with DRS, when coupled with the excellent swagger-codegen project.
My URI scheme prefixes the API, in the format of
/api/v1/foo
. Generated URIs retrieved from the DRF routers fully qualify ViewSets with this prefix.With the
api_path
set to default (/
), full paths appear in the generated docs. This means that swagger-codegen parses the name incorrectly, as it always expects resources to be relative to their base path.Also, if i do set the
api_path
to be/api/v1/foo
, generated client libraries try to access the resource at/api/v1/foo/api/v1/foo/resource
. I think this behaviour is incorrect, as the APIs are supposed to be relative to the resourcebasePath
.This PR adds support for this functionality. With the new
relative_paths
setting set toTrue
, URIs shall be relative to theapi_path
setting. Default value isFalse
, to preserve existing behaviour.