open_api_spex v3.18.3

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

Serialize the given OpenApi spec module to a YAML file.

examples

 Examples 

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

command-line-options

 Command line options

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

  • --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")