OpenAPI (OAS)

Use the OAD plugin when your test suite targets an OpenAPI or Swagger specification. It is the foundational plugin required for most Drift test suites.

Add the plugin to the plugins section of your Drift file:

plugins:
  - name: oas

Use the following table to confirm which specification formats Drift supports.

Each test operation in Drift maps to an endpoint in your OpenAPI file via the target property.

operations:
  getAllValues:
    target: my-oas:getProductByID # Points to the operationId in the OpenAPI document
    description: "Get all values"

Drift automatically maps values from the parameters section of your YAML to the corresponding path, query, or header requirements in the OpenAPI document.

operations:
  getProduct:
    target: my-oas:getProductByID
    parameters:
      path:
        id: 100
      query:
        value: test

You can reference metadata from the current operation in the OpenAPI document as a bound value. This is useful for using spec-defined examples as test inputs.

parameters:
  path:
    id: ${my-oas:operation.parameters.id.example} # Injects the example from the spec
  query:
    value: ${my-oas:operation.summary} # Injects the summary text