Contract Test

Getting Started

Getting Started

CLI Command

Skyramp Generate Command - Contract Testing

skyramp generate contract rest -h
Generate contract tests for REST protocol

Usage:
skyramp generate contract rest <endpoint_url> -X <rest-method> --request-data <sample-request> --response-data <sample-response> [flags]
skyramp generate contract rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate contract rest --help

Arguments:
endpoint_url     Test is created for this endpoint url

Examples:
skyramp generate contract rest https://skyramp.dev/api/products -X POST --request-data @request.json --response-data @response.json --language typescript --framework playwright
skyramp generate contract rest https://skyramp.dev/api/products --api-schema api-schema.json --language python --framework pytest
skyramp generate contract rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language typescript --framework playwright --output skyramp_test.spec.ts --output-dir ./tests/

Input Flags:
       --api-schema                     Path to OpenAPI specification
  -X,  --method                         REST method to be tested
       --request-data                   Sample request data as JSON/YAML blob or @path to a file
       --response-data                  Sample response data as JSON/YAML blob or @path to a file
       --response-status-code           Expected response status code

Param Flags:
       --auth-header                    Authorization header type
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters
       --query-params                   Comma-separated list of query parameters

Output Flags:
       --asserts                        Number of generated body value asserts [none, all] [default: 3]
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection [default: false]
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot] [default: pytest]
       --language                       Language for generated test [java, javascript, python, typescript] [default: python]
       --output                         Generated test name
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation [default: false]

Runtime Flags:
       --docker-network                 Docker network for skyramp worker [default: skyramp]
       --docker-skyramp-port            Docker port for skyramp worker [default: 35142]
  -k,  --insecure                       Skip ssl server verification [default: false]
       --runtime                        Environment where test should run [docker, local]

Inherited Flags:
  -h, --help   Show help for command and list available subcommands

Skyramp Generate Command - Contract Testing

skyramp generate contract rest -h
Generate contract tests for REST protocol

Usage:
skyramp generate contract rest <endpoint_url> -X <rest-method> --request-data <sample-request> --response-data <sample-response> [flags]
skyramp generate contract rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate contract rest --help

Arguments:
endpoint_url     Test is created for this endpoint url

Examples:
skyramp generate contract rest https://skyramp.dev/api/products -X POST --request-data @request.json --response-data @response.json --language typescript --framework playwright
skyramp generate contract rest https://skyramp.dev/api/products --api-schema api-schema.json --language python --framework pytest
skyramp generate contract rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language typescript --framework playwright --output skyramp_test.spec.ts --output-dir ./tests/

Input Flags:
       --api-schema                     Path to OpenAPI specification
  -X,  --method                         REST method to be tested
       --request-data                   Sample request data as JSON/YAML blob or @path to a file
       --response-data                  Sample response data as JSON/YAML blob or @path to a file
       --response-status-code           Expected response status code

Param Flags:
       --auth-header                    Authorization header type
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters
       --query-params                   Comma-separated list of query parameters

Output Flags:
       --asserts                        Number of generated body value asserts [none, all] [default: 3]
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection [default: false]
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot] [default: pytest]
       --language                       Language for generated test [java, javascript, python, typescript] [default: python]
       --output                         Generated test name
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation [default: false]

Runtime Flags:
       --docker-network                 Docker network for skyramp worker [default: skyramp]
       --docker-skyramp-port            Docker port for skyramp worker [default: 35142]
  -k,  --insecure                       Skip ssl server verification [default: false]
       --runtime                        Environment where test should run [docker, local]

Inherited Flags:
  -h, --help   Show help for command and list available subcommands

Skyramp Generate Command - Contract Testing

skyramp generate contract rest -h
Generate contract tests for REST protocol

Usage:
skyramp generate contract rest <endpoint_url> -X <rest-method> --request-data <sample-request> --response-data <sample-response> [flags]
skyramp generate contract rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate contract rest --help

Arguments:
endpoint_url     Test is created for this endpoint url

Examples:
skyramp generate contract rest https://skyramp.dev/api/products -X POST --request-data @request.json --response-data @response.json --language typescript --framework playwright
skyramp generate contract rest https://skyramp.dev/api/products --api-schema api-schema.json --language python --framework pytest
skyramp generate contract rest https://skyramp.dev/api/products --api-schema api-schema.yaml --language typescript --framework playwright --output skyramp_test.spec.ts --output-dir ./tests/

Input Flags:
       --api-schema                     Path to OpenAPI specification
  -X,  --method                         REST method to be tested
       --request-data                   Sample request data as JSON/YAML blob or @path to a file
       --response-data                  Sample response data as JSON/YAML blob or @path to a file
       --response-status-code           Expected response status code

Param Flags:
       --auth-header                    Authorization header type
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters
       --query-params                   Comma-separated list of query parameters

Output Flags:
       --asserts                        Number of generated body value asserts [none, all] [default: 3]
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection [default: false]
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot] [default: pytest]
       --language                       Language for generated test [java, javascript, python, typescript] [default: python]
       --output                         Generated test name
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation [default: false]

Runtime Flags:
       --docker-network                 Docker network for skyramp worker [default: skyramp]
       --docker-skyramp-port            Docker port for skyramp worker [default: 35142]
  -k,  --insecure                       Skip ssl server verification [default: false]
       --runtime                        Environment where test should run [docker, local]

Inherited Flags:
  -h, --help   Show help for command and list available subcommands

© 2025 Skyramp, Inc. All rights reserved.

© 2025 Skyramp, Inc. All rights reserved.

© 2025 Skyramp, Inc. All rights reserved.