Elixir插件中的版本控制API

时间:2019-07-11 17:06:11

标签: elixir plug

我有两个模块:lib / endpoints / v1 / base.ex和lib / endpoints / v2 / base.ex。

lib / endpoints / v1 / base.ex

defmodule Http.Endpoints.V1.Base do
  require Logger
  use Plug.Router

  plug(:match)
  plug(:dispatch)
  plug(Plug.Logger)
  plug(Plug.Parsers, parsers: [:json], json_decoder: Poison)

  get "/v1/ping" do
    send_resp(conn, 200, "pong!")
  end
end

lib / endpoints / v2 / base.ex

defmodule Http.Endpoints.V2.Base do
  require Logger
  use Plug.Router

  plug(:match)
  plug(:dispatch)
  plug(Plug.Logger)
  plug(Plug.Parsers, parsers: [:json], json_decoder: Poison)

  get "/v2/ping" do
    send_resp(conn, 200, "pong! 2")
  end
end

如果我放入应用程序,则我的端点正常工作。例如孩子

Plug.Cowboy.child_spec(scheme: :http, plug: Http.Endpoints.V1.Base, options: [port: Application.get_env(:http, :port)])

但是我希望我的应用程序启动所有端点版本。

我尝试使用require Http.Endpoints.V1.Baserequire Http.Endpoints.V2.Base创建lib / endpoints.ex,并更改了我的application.ex,但没有用。

2 个答案:

答案 0 :(得分:5)

您可以从端点文件转发到其他路由器。这是forward/2函数的文档:https://hexdocs.pm/plug/Plug.Router.html#forward/2

基本上,您为v1和v2创建了2个路由器:

defmodule MyAppWeb.V2.Router do
  use Plug.Router

  get "/ping" do
    send_resp(conn, 200, "OK")
  end
end

defmodule MyAppWeb.V1.Router do
  use Plug.Router

  get "/ping" do
    send_resp(conn, 200, "OK")
  end
end

然后在您的端点中,您可以添加所有常用功能并转发到版本化路由,如下所示:

defmodule MyAppWeb.Endpoint do
  require Logger
  use Plug.Router

  plug(:match)
  plug(:dispatch)
  plug(Plug.Logger)
  plug(Plug.Parsers, parsers: [:json], json_decoder: Poison)

  # Forwarding
  forward "/v2", to: MyApp.V2.Router
  forward "/v1", to: MyApp.V1.Router

  # You should put a catchall here
  match _ do
    send_resp(conn, 404, "Not Found")
  end
end

然后在您的application.ex文件中,像以前一样安装端点。但是,此时,您应该能够从同一端口ping /v1/ping/v2/ping

干杯!

答案 1 :(得分:1)

  

如果我放入应用程序,则端点可以正常工作。   孩子们

Plug.Cowboy.child_spec(
   scheme: :http, 
   plug: Http.Endpoints.V1.Base, 
   options: [port: Application.get_env(:http, :port)]
)

现代的指定方式是:

{Plug.Cowboy, [[ 
      scheme: :http, 
      plug: Http.Endpoints.V1.Base, 
      options: [port: Application.get_env(:http, :port)]
    ]]
}

请参阅:https://hexdocs.pm/elixir/Supervisor.html#module-child_spec-1

尽管,对我来说,直接调用child_spec()似乎更容易,而不是尝试找出围绕该参数需要多少个括号。