View Source mix openapi.spec.yaml (open_api_spex v3.21.2)

Serialize the given OpenApi spec module to a YAML file.

Examples

$ mix openapi.spec.yaml --spec PhoenixAppWeb.ApiSpec apispec.yaml
$ mix openapi.spec.yaml --spec PhoenixAppWeb.ApiSpec --check=true
$ mix openapi.spec.yaml --spec PhoenixAppWeb.ApiSpec --start-app=false
$ mix openapi.spec.yaml --spec PhoenixAppWeb.ApiSpec --vendor-extensions=false

Command line options

• --spec - The ApiSpec module from which to generate the OpenAPI YAML file

• --check - Whether to only compare the generated YAML with the spec file (defaults to false)

• --start-app - Whether to start the application before generating the schema (defaults to true)

• --vendor-extensions - Whether to include open_api_spex OpenAPI vendor extensions (defaults to true)

• --quiet - Whether to disable output printing (defaults to false)

• --filename - The output filename (defaults to "openapi.yaml")