make serving path configurable #204
Conversation
| url: window.location.origin + "/api-docs/swagger.json", | ||
| url: window.location.toString().replace("/index.html", "/swagger.json"), |
There was a problem hiding this comment.
Could you explain this change, please?
Also, I can't remember, but are we testing this somewhat?
You might want to look into up_swagger.sh because there's logic for this file, there.
There was a problem hiding this comment.
I suppose here provided trying dynamically change api-docs but... this will not works as expected. Because specific window location will return specific value... Need find other approach.
There was a problem hiding this comment.
Also, I can't remember, but are we testing this somewhat?
Based on CI results - no.
There was a problem hiding this comment.
What if.. during build this project the value /api-docs/ will be replaced based on config values? I suppose it can be done in rebar.config level as well.
There was a problem hiding this comment.
yeah… env variable or macro would be great for that.
| {file, StaticFiles ++ "/index.html"}, | ||
| {file, Path ++ "/index.html"}, |
There was a problem hiding this comment.
I seem to not be able to follow this change. Would you elaborate, please?
There was a problem hiding this comment.
It looks like here need use StaticFiles as it was before, because only path should be dynamic - maybe was added by mistake?
| cowboy_swagger_redirect_handler, | ||
| {file, StaticFiles ++ "/index.html"}, | ||
| {file, Path ++ "/index.html"}, |
There was a problem hiding this comment.
| {file, Path ++ "/index.html"}, | |
| {file, StaticFiles ++ "/index.html"}, |
| moved_permanently(Req, State) -> | ||
| {{true, "/api-docs/index.html"}, Req, State}. | ||
| moved_permanently(Req, {file, File} = State) -> | ||
| {{true, File}, Req, State}. |
There was a problem hiding this comment.
Hm... I can be wrong but maybe
| {{true, File}, Req, State}. | |
| Path = application:get_env(cowboy_swagger, path, "/api-docs"), | |
| {{true, Path ++ "/" ++ File}, Req, State}. |
?
| @@ -119,6 +119,9 @@ Additionally, `cowboy_swagger` can be configured/customized from a `*.config` fi | |||
| %% cowboy_swagger config | |||
| {cowboy_swagger, | |||
| [ | |||
| %% `path`: Path where you can access Swagger-UI. Default: `/api-docs`. | |||
There was a problem hiding this comment.
@vkatsuba I'm not sure what you wanted to add with your comment. The fact that the default value is /api-docs was already established in the original text.
|
@vkatsuba I guess you're out of luck 🤷 |
Not really. Actually I was want to prepare something but then Mr. @paulo-ferraz-oliveira mention this PR. Give me few days please, when I have a little more free time and I will try finished this PR with mention original author and link PR's and task. Of course if @xetalr do not want finished this one or prepare new one 🙃. |
|
No need for Mr. 😄 I'm younger than Brujo. |
Sometimes there is a need to use a custom path for Swagger UI. It is hard-coded as api-docs at the moment. Here is proposed implementation.