Allow swagger-servant-ui with redoc to be nested in an API #53
Conversation
This file contains hidden or 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
In the current state, if we were to declare a servant-swagger-ui server behind some path, for instance:
type API =
"docs" :> ServantSwaggerUI "swagger-ui" "swagger.json"
One would correctly have access to the template in `<host>/docs/swagger.ui`
but the template would refer to a swagger.json at `/swagger.json`
whereas it is hosted under `/docs/swagger.json`. To cope with this, we
can use relative paths in the template, making sure that the current url
is always ending with a slash.
|
This isn't a problem with vanilla |
|
I am not sure but could be. It depends on how the assets are referenced in the template I suppose. Haven't verified for the jensoleg package either. |
KtorZ
added a commit
to input-output-hk/cardano-sl
that referenced
this pull request
Aug 14, 2018
There's actually a bug in the current template which serves the swagger specs on an absolute url , completely ignoring any sub-path in the URL. A PR has been submitted to the upstream library (servant-swagger-ui-redoc) haskell-servant/servant-swagger-ui#53 but until it gets accepted, we need a way to serve our documentation
12 tasks
|
Apologies for the delay! |
KtorZ
added a commit
to input-output-hk/cardano-sl
that referenced
this pull request
Nov 9, 2018
There's actually a bug in the current template which serves the swagger specs on an absolute url , completely ignoring any sub-path in the URL. A PR has been submitted to the upstream library (servant-swagger-ui-redoc) haskell-servant/servant-swagger-ui#53 but until it gets accepted, we need a way to serve our documentation
KtorZ
added a commit
to input-output-hk/cardano-wallet-legacy
that referenced
this pull request
Nov 9, 2018
There's actually a bug in the current template which serves the swagger specs on an absolute url , completely ignoring any sub-path in the URL. A PR has been submitted to the upstream library (servant-swagger-ui-redoc) haskell-servant/servant-swagger-ui#53 but until it gets accepted, we need a way to serve our documentation
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.
In the current state, if we were to declare a servant-swagger-ui server behind some path, for instance:
One would correctly have access to the template in
<host>/docs/swagger.uibut the template would refer to a swagger.json at/swagger.jsonwhereas it is hosted under/docs/swagger.json. To cope with this, we can use relative paths in the template, making sure that the current url is always ending with a slash.Note also that without a trailing slash, it will fail at loading assets like the initial
redoc.min.hsbundle, so it is rather important to enforce strict URL-routing here.