View Source OpenApiSpexYaml

TODO: Add description

installation

Installation

If available in Hex, the package can be installed by adding open_api_spex_yaml to your list of dependencies in mix.exs:

def deps do
  [
    {:open_api_spex_yaml, "~> 3.11.0"}
  ]
end

generating-the-spec

Generating the Spec

You can write the swagger file to disk using the following Mix task:

mix openapi.spec.yaml --spec MyAppWeb.ApiSpec

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/open_api_spex_yaml.