feat: swagger & swagger-ui

[enricoprazeres]

Closes #4

• Kept the test_controller so the reviewer can test it and visualize something on the swagger.
• To add a new controller to Swagger, you need to define Swagger documentation using the swagger_path macro inside the controller module just like that:

  use PhoenixSwagger

  swagger_path :index do
    get("/api/test")
    summary("Health check")
    description("Returns a simple OK message.")
    produces("application/json")
    response(200, "Success", Schema.ref(:HealthResponse))
  end

• And run mix phx.swagger.generate.
• As long as it's reviewed, I can remove the test_controller.

[deployum]

The preview deployment failed. 🔴

Open Build Logs

Last updated at: 2025-07-15 20:27:44 CET

[MarioRodrigues10]

Please also change in endpoint.ex the following lines

  plug Plug.Static,
    at: "/",
    from: :atlas,
    gzip: false,
    only: AtlasWeb.static_paths()

to

  plug Plug.Static,
    at: "/",
    from: :atlas,
    gzip: false,
    only: ~w(css fonts images js favicon.ico robots.txt swagger.json)

[joaodiaslobo]

Use schemas to specify exactly the format of the content that gets returned. Maybe also add an example?