craftr req run

Execute a request instance against an environment. Prints the response body by default.

Usage

craftr req run <resource/name> --env <env> [--api <api>] [--var <k=v>…] [--set <ns.k=v>…] [--enable-middleware <ref>…] [--disable-middleware <ref>…] [--full] [--trust] [--verbose]

Flags

FlagDescription
--env-erequiredEnvironment name.
--api-aAPI slug.
--varrepeatableOverride an environment variable: key=value. The variable must be declared in the environment schema.
--setrepeatableOverride a request parameter: <path|query|header|cookie|body|middleware>.key=value. Body keys support dot-notation. middleware.<name[#export]>.<key>=<value> overrides a middleware option for this run and enables that middleware.
--enable-middlewarerepeatableEnable a middleware of the request chain for this run only: "name" (every export of that file) or "name#export". Not saved.
--disable-middlewarerepeatableDisable a middleware of the request chain for this run only: "name" or "name#export". Not saved.
--fullPrint the full execution result instead of just the response body.
--trustAllow this project's scripts to run for this invocation only. Never saved.
--verbose-vPrint the trace to stderr. -v is info, -vv adds debug.

Examples

craftr req run Pet/get-pet -e dev
craftr req run Pet/get-pet -e dev --set path.petId=3 | jq '.name'
craftr req run Pet/get-pet -e dev --var apiKey=sk-test --full
craftr req run Pet/get-pet -e dev --disable-middleware tracing --set middleware.filters#byStatus.status=404

See also