phoenix_swagger v0.8.3

PhoenixSwagger.Plug.SwaggerUI (phoenix_swagger v0.8.3) View Source

Swagger UI in a plug.

Examples

Generate a swagger file and place it in your applications priv/static dir:

mix phoenix.swagger.generate priv/static/myapp.json

Add a swagger scope to your router, and forward all requests to SwaggerUI

scope "myapp/api/swagger" do
  forward "/", PhoenixSwagger.Plug.SwaggerUI, otp_app: :myapp, swagger_file: "myapp.json"
end

Run the server with mix phoenix.server and browse to localhost:8080/myapp/api/swagger/, swagger-ui should be shown with your swagger spec loaded.

Link to this section Summary

Functions

call(conn, opts)

Plug.call callback

init(opts)

Plug.init callback

Link to this section Functions

Link to this function

call(conn, opts)

View Source

Plug.call callback

Link to this function

init(opts)

View Source

Plug.init callback

Options:

  • otp_app (required) The name of the app has is hosting the swagger file
  • swagger_file (required) The name of the file, eg "swagger.json"
  • config_object (optional) These values are injected into the config object passed to SwaggerUI.
  • config_url (optional) Populates the configUrl Swagger UI parameter. A URL to fetch an external configuration document from.