Back to Docs

yapi test

Run all *.test.yapi, *.test.yapi.yml, *.test.yapi.yaml files in the current directory or specified directory

yapi test [directory] [flags]

Options

  -a, --all                     Run all *.yapi, *.yapi.yml, *.yapi.yaml files (not just test files)
  -e, --env string              Target environment from yapi.config.yml
  -h, --help                    help for test
      --no-start                Skip starting the dev server (even if configured in yapi.config.yml)
  -p, --parallel int            Number of parallel threads to run tests on (default 1)
      --start string            Command to start the dev server (overrides yapi.config.yml)
  -v, --verbose                 Show verbose output for each test
      --wait-on strings         URL(s) to wait for before running tests (http://, grpc://, tcp://)
      --wait-timeout duration   Health check timeout (default 1m0s)

Options inherited from parent commands

      --binary-output   Display binary content to stdout (by default binary content is hidden)
      --insecure        Skip TLS verification for HTTPS requests; use insecure transport for gRPC
      --no-color        Disable color output
  -u, --url string      Override the URL specified in the config file

SEE ALSO

  • yapi - yapi is a unified API client for HTTP, gRPC, and TCP
Auto generated by spf13/cobra on 29-Jan-2026