Star

Created With

linkSwagger & Open API

If you already have an Open API / swagger defined, you can use it to validate actual responses.

Both JSON and YAML files are supported.

⚠️ NOTE: All $ref are dynamically de-referenced automatically, those both local AND remote.



specs/example-spec.yml
1link  - name: get users

2link    request:

3link      path: /users

4link      method: get

5link    response:

6link      json_schema:

7link        type: file

8link        # note the use of %2F to escape the "application/json" part of the path

9link        $ref: 'docs/paths/register.yml#/post/responses/200/content/application%2Fjson/schema'

docs/paths/register.yml
1linkpost:

2link  responses:

3link    '200':

4link      content:

5link        application/json:

6link          schema:

7link            type: object

8link            properties:

9link              dob:

10link                type: string

11link                format: date-time

12link            required: [ dob ]


💡 NOTE: paths containing a forward slash can be URL-encoded as %2F



See also:



Swagger & Open API

Home

Getting Startedchevron_right

Installation Basic Usage GraphQL

Basicschevron_right

Overview Meta Config Specs

Requestchevron_right

Request Basics Headers Cookies Query Parameters Path Parameters

Payload Bodychevron_right

JSON Body Binary Data URL Encoded Form Data Multi-Part Form Data

File Uploads Auto-Retry Additional Options

Response Validationchevron_right

Overview

Assertionschevron_right

Exact Value Regular Expression Exact Value Custom JS Validator

Status Code Headers & Cookies

Bodychevron_right

Overview Exact Value Regular Expression JSON Path JSON Schema Inline JSON Schema File Swagger / Open API

Hooks & JSchevron_right

Overview

Function Typeschevron_right

JS Inline Functions JS Async Inline Functions JS Modules

Suite-Level Hookschevron_right

before_all after_all before_each after_each

Spec-Level Hookschevron_right

before_test after_test

Contextchevron_right

Suite Context Test Context Response Context

DRY & Reusing Specschevron_right

Overview Looping Yaml Anchors Run Existing Spec

Command Line Interface (CLI)chevron_right

Basics Debugging Running in Parallel Options Reporters

GitHub