CafeRacer

CafeRacer

Trying to use open_api_spex in my phoenix project.

When I try compiling the project with mix a warning pops us
OpenApiTest.OpenApiSpex.Plug.RenderSpec.init/1 is undefined

I have my router defined as below:

defmodule OpenApiTestWeb.Router do
  use OpenApiTestWeb, :router

  pipeline :browser do
    plug :accepts, ["html"]
    plug :fetch_session
    plug :fetch_flash
    plug :protect_from_forgery
    plug :put_secure_browser_headers
  end

  pipeline :api do
    plug :accepts, ["json"]
    plug OpenApiSpex.Plug.PutApiSpec, module: OpenApiTestWeb.ApiSpec
  end

  scope "/", OpenApiTestWeb do
    pipe_through :browser

    get "/", PageController, :index
    get "/payments", PaymentController, :create_payment
    get "/openapi", OpenApiSpex.Plug.RenderSpec, []
  end

  if Mix.env() in [:dev, :test] do
    import Phoenix.LiveDashboard.Router

    scope "/" do
      pipe_through :browser
      live_dashboard "/dashboard", metrics: OpenApiTestWeb.Telemetry
    end
  end
end

OpenApiSpex.Plug.RenderSpec module is present in the deps as below.

defmodule OpenApiSpex.Plug.RenderSpec do


      defmodule MyAppWeb.Router do
        use Phoenix.Router
        alias MyAppWeb.UserController

        pipeline :api do
          plug :accepts, ["json"]
          plug OpenApiSpex.Plug.PutApiSpec, module: MyAppWeb.ApiSpec
        end

        scope "/api" do
          pipe_through :api
          resources "/users", UserController, only: [:create, :index, :show]
          get "/openapi", OpenApiSpex.Plug.RenderSpec, []
        end
      end


  alias OpenApiSpex.Plug.PutApiSpec
  @behaviour Plug
  @json_encoder Enum.find([Jason, Poison], &Code.ensure_loaded?/1)

  @impl Plug
  def init(opts), do: opts

  @impl Plug
  def call(conn, _opts) do
    {spec, _} = PutApiSpec.get_spec_and_operation_lookup(conn)

    conn
    |> Plug.Conn.put_resp_content_type("application/json")
    |> Plug.Conn.send_resp(200, @json_encoder.encode!(spec))
  end
end

Could someone kindly help?

Showing Posts 1 to 3

josevalim

josevalim

Creator of Elixir

Assuming the error message above is what Mix is printing, notice that it is prepending OpenApiTest to the module name. That’s not supposed to happen unless you are defining an alias somewhere of OpenApiSpex to OpenApiTest.OpenApiSpex or similar. Check your router and web.ex file.

If the above is not the correct warning, can you please print the full warning, including file+line info?

CafeRacer

CafeRacer OP

Thanks JV for the prompt support.

Below is the complete warning.

warning: OpenApiTestWeb.OpenApiSpex.Plug.RenderSpec.init/1 is undefined (module OpenApiTestWeb.OpenApiSpex.Plug.RenderSpec is not available or is yet to be defined)
  lib/open_api_test_web/router.ex:22: OpenApiTestWeb.Router.__checks__/0

Below is my troubleshooting:

When I have

get "/openapi", OpenApiSpex.Plug.RenderSpec, [] inside the /api block like below

scope "/api", OpenApiTestWeb do
    pipe_through :api
    get "/openapi", OpenApiSpex.Plug.RenderSpec, []  
  end

It pops us the warning, appends the OpenApiTestWeb to .OpenApiSpex.Plug.RenderSpec the and eventually fails to render the specs since the render could not take place.

When I moved get "/openapi", OpenApiSpex.Plug.RenderSpec, [] out of the “/api” scope block, the warning disappears and the call to the OpenApiSpex.Plug.RenderSpec is succesful.

Am I missing something? Curious to dig it down. Thank you.
:slight_smile:

josevalim

josevalim

Creator of Elixir

Oh, I see. The issue is the scope. The scope ..., OpenApiTestWeb will nest everything inside under OpenApiTestWeb. Do this instead:

  scope "/api" do
    pipe_through :api
    get "/openapi", OpenApiSpex.Plug.RenderSpec, []  

    scope OpenApiTestWeb do
      ....
    end
  end
— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
water
I’m aware of 2 such projects, are there others? git: GitHub - team-alembic/realworld: A fullstack Phoenix LiveView application with back...
New
itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
leoschweizer
Hi, we run different LLM models across a cluster, with each node loading a configurable subset. Model-specific queues let nodes consume ...
New
rlipscombe
When I use Mix.install with a git dependency, using git@github.com:... how do I change the SSH identity used? I’ve got two Github accoun...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews