Add possibility to configure own path to "/api-docs/swagger.json"

.github/workflows/ci.yml

@@ -14,17 +14,17 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        otp_vsn: ['24', '25', '26']
+        otp_vsn: ['25', '26', '27']
         rebar3_vsn: ['3.22']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         id: setup-beam
         with:
           otp-version: ${{matrix.otp_vsn}}
           rebar3-version: ${{matrix.rebar3_vsn}}
       - name: Restore _build
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             _build
@@ -35,7 +35,7 @@ jobs:
                 -rebar3-${{steps.setup-beam.outputs.rebar3-version}}\
                 -hash-${{hashFiles('rebar.lock')}}"
       - name: Restore rebar3's cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/rebar3
           key: "rebar3-cache-for\

.github/workflows/up_swagger.sh

@@ -22,7 +22,7 @@ rm -rf node_modules
 
 # Same as https://github.com/swagger-api/swagger-ui/blob/63ad6f6a5bce19075e717ea74acaf9f7055dcdf5/docker/docker-entrypoint.d/40-swagger-ui.sh#L12
 FIND="\"https://petstore.swagger.io/v2/swagger.json\""
-REPLACE="window.location.origin + \"/api-docs/swagger.json\""
+REPLACE="window.location.origin + __SWAGGER_PATH__ + \'/swagger.json\'"
 sed -i -e "s|${FIND}|${REPLACE}|g" priv/swagger/swagger-initializer.js
 
 echo "${NEW_SWAGGER_VSN}" >SWAGGER_VSN

.gitignore

@@ -4,3 +4,6 @@ erl_crash.dump
 doc/
 .rebar3
 logs
+rebar3
+/priv/swagger/swagger-initializer.js
+cowboy_swagger_hook.beam

README.md

@@ -119,6 +119,8 @@ 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`
+   {path, "/api-docs-swagger"},
    %% `static_files`: Static content directory. This is where Swagger-UI
    %% is located. Default: `priv/swagger`.
    %% Remember that Swagger-UI is embedded into `cowboy-swagger` project,
@@ -133,7 +135,8 @@ Additionally, `cowboy_swagger` can be configured/customized from a `*.config` fi
    {global_spec,
     #{swagger => "2.0",
       info => #{title => "Example API"},
-      basePath => "/api-docs"
+      %% See "path" config section
+      basePath => "/api-docs-swagger"
      }
    }
   ]

priv/swagger/swagger-initializer.js → priv/swagger/swagger-initializer.template

@@ -3,7 +3,7 @@ window.onload = function() {
 
   // the following lines will be replaced by docker/configurator, when it runs in a docker-container
   window.ui = SwaggerUIBundle({
-    url: window.location.origin + "/api-docs/swagger.json",
+    url: window.location.origin + __SWAGGER_PATH__ + '/swagger.json',
     dom_id: '#swagger-ui',
     deepLinking: true,
     presets: [

priv/update_swagger_url

@@ -0,0 +1,41 @@
+#! /usr/bin/env escript
+
+-module(update_swagger_url).
+
+-export([main/1]).
+
+main(_) ->
+  %% Define the path to the template and the output file
+  TemplateFilePath = "priv/swagger/swagger-initializer.template",
+  OutputFilePath = "priv/swagger/swagger-initializer.js",
+
+  %% Read the contents of the template file
+  case file:read_file(TemplateFilePath) of
+      {ok, Content} ->
+          %% Get the configuration for the path from the application environment
+          Path = application:get_env(cowboy_swagger, path, "/api-docs"),
+
+          %% Ensure Path is a binary (if it's a list, convert to binary)
+          BinPath = case is_binary(Path) of
+              true -> Path;
+              false -> list_to_binary(Path)
+          end,
+
+          %% Replace the placeholder in the template file content
+          %% Ensure both the placeholder and replacement are binaries
+          ModifiedContent = binary:replace(Content, <<"__SWAGGER_PATH__">>, <<"'", BinPath/binary, "'">>, [global]),
+
+          %% Write the modified content to the new JavaScript file
+          case file:write_file(OutputFilePath, ModifiedContent) of
+              ok ->
+                  %% Successfully written, log the updated path
+                  io:format("Swagger path updated to: ~s~n", [Path]);
+              {error, WriteError} ->
+                  %% Failed to write the new file
+                  io:format("Failed to write swagger-initializer.js: ~p~n", [WriteError])
+          end;
+
+      {error, ReadError} ->
+          %% Failed to read the template file
+          io:format("Failed to read swagger-initializer.template: ~p~n", [ReadError])
+  end.

rebar.config

@@ -21,6 +21,8 @@
 
 {deps, [{jsx, "3.1.0"}, {cowboy, "2.10.0"}, {ranch, "2.1.0"}, {trails, "2.3.1"}]}.
 
+{pre_hooks, [{compile, "priv/update_swagger_url"}]}.
+
 {project_plugins,
  [{rebar3_hank, "~> 1.4.0"},
   {rebar3_hex, "~> 7.0.7"},

src/cowboy_swagger_handler.erl

@@ -33,19 +33,20 @@ trails(Options) ->
             _ ->
                 filename:join(cowboy_swagger_priv(), "swagger")
         end,
+    SwaggerPath = application:get_env(cowboy_swagger, path, "/api-docs"),
     Redirect =
-        trails:trail("/api-docs",
+        trails:trail(SwaggerPath,
                      cowboy_swagger_redirect_handler,
                      {file, StaticFiles ++ "/index.html"},
                      #{get => #{hidden => true}}),
     Static =
-        trails:trail("/api-docs/[...]",
+        trails:trail(SwaggerPath ++ "/[...]",
                      cowboy_static,
                      {dir, StaticFiles, [{mimetypes, cow_mimetypes, all}]},
                      #{get => #{hidden => true}}),
     MD = #{get => #{hidden => true}},
     Handler =
-        trails:trail("/api-docs/swagger.json", cowboy_swagger_json_handler, Options, MD),
+        trails:trail(SwaggerPath ++ "/swagger.json", cowboy_swagger_json_handler, Options, MD),
     [Redirect, Handler, Static].
 
 %% @private

src/cowboy_swagger_redirect_handler.erl

@@ -36,4 +36,5 @@ previously_existed(Req, State) ->
 -spec moved_permanently(Req :: cowboy_req:req(), State :: state()) ->
                            {{true, iodata()}, cowboy_req:req(), state()}.
 moved_permanently(Req, State) ->
-    {{true, "/api-docs/index.html"}, Req, State}.
+    SwaggerPath = application:get_env(cowboy_swagger, path, "/api-docs"),
+    {{true, SwaggerPath ++ "/index.html"}, Req, State}.