Hot to remove/move general scope prefix from paths

[ycherniavskyi]

For example, I get the next routes:

  #...
  scope "/api", AppWeb, as: :api do
    pipe_through :api

    scope "/v1", Api.V1, as: :v1 do
      get "/open-api", OpenApiSpex.Plug.RenderSpec, [], alias: false

      scope "/otp" do
        post "/request", OtpController, :request
        post "/verify", OtpController, :verify
      end
    end
  end
  #...

and in result I get the next OpenAPI JSON:

{
  ...

  "paths": {
    "/api/v1/otp/request": {
      ...
    },
    "/api/v1/otp/verify": {
      ...
    }
  },
  ...
  "servers": [
    {
      "url": "http://localhost:4000",
      "variables": {}
    }
  ],
  ...
}

Is it possible to somehow move the general scope prefix /api/v1 from paths to for example server url?

If it is not possible automatically then, so maybe is it possible to remove the general scope prefix /api/v1 from paths? So then I add it to the server url manually.

[mbuhot]

Hi @ycherniavskyi, you should be able to adjust the paths by transforming the output of Paths.from_router/1 when you build the %OpenApi{} struct.

Something like:

defmodule MyAppWeb.ApiSpec do
  alias OpenApiSpex.{Components, Info, OpenApi, Paths, Server}
  alias MyAppWeb.{Endpoint, Router}
  @behaviour OpenApi

  @impl OpenApi
  def spec do
    %OpenApi{
      servers: [
        %{Server.from_endpoint(Endpoint) | url: "/api/v1"}
      ],
      info: %Info{
        title: "My App",
        version: "1.0"
      },
      paths: Router |> Paths.from_router() |> Map.new(fn {"/api/v1/"<>path, operations} -> {path, operations} end)
    }
    |> OpenApiSpex.resolve_schema_modules() 
  end
end

[ycherniavskyi]

Thank you for your hint!

This is funny, but I end up with almost the same approach!