Fix for openapi.json location if another root directory #378
+2
−2
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
Another root fix for starlette
kemingy
reviewed
Oct 30, 2024
| @@ -79,7 +79,7 @@ def register_route(self, app: Any): | |||
| f"/{self.config.path}/{ui}", | |||
| self.DOC_PAGE_ROUTE_CLASS( | |||
| self.config.page_templates[ui], | |||
| spec_url=self.config.spec_url, | |||
| spec_url=self.config.filename, | |||
There was a problem hiding this comment.
spec_url is f"/{self.path}/{self.filename}", I don't get why it should only contain the filename. Can you explain in detail?
There was a problem hiding this comment.
As I wrote to comment - absolute address is /apidoc/openapi.json ; so for example for:
- http://foo.bar => http://foo.bar/apidoc.openapi.json
- http://foo.bar/foo/bar/ => http://foo.bar/apidoc/openapi.json
But if there is some subdirectory for API, for example if multiple APIs is available, then absolute address is not good solution. For example base root dirs (basepaths) for APIs:
- http://foo.bar/foo/bar/ => http://foo.bar/apidoc/openapi.json ====\ conflict!!!
- http://foo.bar/bar/foo/ => http://foo.bar/apidoc/openapi.json ====/
Right paths should be: - http://foo.bar/foo/bar/ => http://foo.bar/foo/bar/apidoc/openapi.json
- http://foo.bar/bar/foo/ => http://foo.bar/bar/foo/apidoc/openapi.json
...If you have set some root directory for API, swagger and redoc try to find file absolutely on /apidoc/openapi.json (not relatively) so it show errors only. It is needed to search openapi.json in set subdirectory.
kemingy
approved these changes
Oct 31, 2024
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.
(for example /foo/bar -> /foo/bar/apidoc/openapi.json instead of /apidoc/openapi.json)