GoodAnalytics.ApiSpec.Router (GoodAnalytics v0.1.1)

Copy Markdown View Source

Router that serves OpenAPI spec JSON and Swagger UI.

Mount in your host application:

forward "/api/docs", GoodAnalytics.ApiSpec.Router

Provides:

  • GET /openapi — OpenAPI 3.0 spec as JSON
  • GET /swaggerui — interactive Swagger UI

Summary

Functions

api_spec(conn, _)
call(conn, opts)

Callback invoked by Plug on every request.

formatted_routes(_)

Callback implementation for Phoenix.VerifiedRoutes.formatted_routes/1.

init(opts)

Callback required by Plug that initializes the router for serving web requests.

verified_route?(_, split_path)

Callback implementation for Phoenix.VerifiedRoutes.verified_route?/2.

Functions

api_spec(conn, _)

call(conn, opts)

Callback invoked by Plug on every request.

formatted_routes(_)

Callback implementation for Phoenix.VerifiedRoutes.formatted_routes/1.

init(opts)

Callback required by Plug that initializes the router for serving web requests.

verified_route?(_, split_path)

Callback implementation for Phoenix.VerifiedRoutes.verified_route?/2.