Getting Started

Quick Start

Specification

Basic Structure API Specification Keys Python Code Environment Variables Custom Variables Chaining Requests API Specification in Multiple Files

Configuration

Command Line Interface - CLI Configuration File Hiding Sensitive Information

API Specification in Multiple Files

With !include, it is possible to build your API specification in multiple files.

For example, these two files

# scanapi.yaml
endpoints:
  - name: scanapi-demo
    path: ${BASE_URL}
    requests: !include include.yaml

# include.yaml
- name: health
  path: /health/

would generate:

endpoints:
  - name: scanapi-demo
    path: ${BASE_URL}
    requests:
      - name: health
        path: /health/