serving_doc.md

Serving generated doc

You can use Xcribe to serve your API documentation. Currently we support serve Swagger format. To render documentation we use Swagger UI.

Configuration

For serving with Xcribe you must configure doc format as :swagger the output path must be priv/static and you must enable serve config.

      config :xcribe,
        information_source: YourApp.YouModuleInformation,
        format: :swagger,
        output: "priv/static/my_doc.json",
        serve: true

Routing

Add a doc scope to your router, and forward all requests to Xcribe.Web.Plug

      scope "doc/swagger" do
        forward "/", Xcribe.Web.Plug
      end