添加swagger到phoenix框架應用程序

Question

我是Elixir/Phoenix的新手。有沒有辦法將Swagger文檔添加到Phoenix api項目中？

我看着https://github.com/xerions/phoenix_swagger，但是這已在幾個月前更新，並且有未解決的舊開放問題。

這是另一個具有相似問題的https://github.com/OpenAperture/swaggerdoc。

或者我應該使用Maru進行api項目嗎？

Answer 1

兩個項目都會得到更新。 SwaggerDoc提供Ecto支持，但構建狀態已失敗兩個月。

PhoenixSwagger沒有，但取決於擴展控制器（您可以使用它來自己實現Ecto支持）。此外，它似乎目前正在積極維護。

Answer 2

我們正積極與附加功能保持https://github.com/everydayhero/phoenix_swagger

defmodule MyApp.UserController do 
    use MyApp.Web, :controller 
    import PhoenixSwagger 

    swagger_path :index do 
    get "/users" 
    summary "Get users" 
    description "Get all users" 
    response 200, "Success", :Users 
    tag "users" 
    end