Namit

Namit

defmodule KayaanPrintsWeb.Router.AdminRouter do
  use KayaanPrintsWeb, :router

  pipeline :api do
    plug :accepts, ["json"]
    plug :fetch_session
  end

  scope "/v1" do
    pipe_through :api

    scope "/", KayaanPrintsWeb do
      get "/", DefaultController, :index

      forward "/medias/", Router.MediaRouter
      forward "/products/", Router.ProductRouter
      forward "/collections/", Router.CollectionRouter
    end
  end
end

This is the admin router which forwards requests to other routers. I want to create documentation for all of the endpoints of these 3 routers on a single page. so I have defined this module:

defmodule KayaanPrintsWeb.SuperAdminApiSpec do
  alias OpenApiSpex.{Components, Contact, Info, OpenApi, Paths, Server, SecurityScheme}
  alias KayaanPrintsWeb.Endpoint
  alias KayaanPrintsWeb.Router.AdminRouter

  @behaviour OpenApi

  @impl OpenApi
  def spec do
    %OpenApi{
      components: %Components{
        securitySchemes: %{
          "authorization" => %SecurityScheme{
            type: "http",
            scheme: "bearer",
            bearerFormat: "JWT"
          }
        }
      },
      servers: [
        Server.from_endpoint(Endpoint)
      ],
      info: %Info{
        title: "Kayaan Prints Super Admin API",
        description: "API documentation for Kayaan Prints Super Admin Management",
        contact: %Contact{
          name: "name",
          email: "email"
        },
        version: to_string(Application.spec(:kayaan_prints, :vsn))
      },
      paths: merge_paths(AdminRouter)
    }
    |> OpenApiSpex.resolve_schema_modules()
  end
end

And I have defined the super-admin router which contains the endpoint for swaggerui. Now when I open the swaggerui page, it says: No operations defined in spec!. So it’s not working for forwarded endpoints.

Then, I tried merging the paths of all the 3 routers like this:

....
paths: merge_paths([ProductRouter, MediaRouter, CollectionRouter])
....
defp merge_paths(routers) do
    routers
    |> Enum.flat_map(& &1.__routes__())
    |> Paths.from_routes()
  end

now it’s overwriting the operations with the same name. for example, ProductController and MediaController contains index function and hence :index operation. So the index operation from product controller will be overwritten by the index operation from the media controller. and at the end I get doc for only 5 endpoints out of many. Furthermore, they do not contain the correct endpoint prefix as seen in the image I have attached.

So is there any ideal way of listing all the endpoints from multiple routers altogether?

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews