Hinzufügen Swagger zu Phoenix Framework-Anwendung

Question

Ich bin neu in Elixir/Phoenix. Gibt es eine Möglichkeit, Swaggers Dokumentation dem Phoenix API Projekt hinzuzufügen?

Ich schaute auf https://github.com/xerions/phoenix_swagger, aber das wurde vor einigen Monaten aktualisiert und hat alte ungelöste Probleme ungelöst.

Dies ist ein weiterer https://github.com/OpenAperture/swaggerdoc mit ähnlichen Problemen.

Oder sollte ich Maru für API-Projekte verwenden?

Answer 1

Beide Projekte erhalten Updates. SwaggerDoc bietet Ecto-Unterstützung, aber der Build-Status ist seit zwei Monaten fehlgeschlagen.

PhoenixSwagger nicht, aber hängt davon ab, den Controller zu erweitern (mit dem Sie Ecto-Unterstützung selbst implementieren können). Auch scheint es im Moment aktiv gepflegt zu sein.

Answer 2

Wir aktiv https://github.com/everydayhero/phoenix_swagger mit zusätzlichen Features

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 

pflegen