Getting Started

Quick Start

Specification

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

Configuration

Command Line Interface - CLI Configuration File Hiding Sensitive Information Custom Report

Configuration File

If you want to configure the ScanAPI with a file, you can create a local scanapi.conf file where you are running the ScanAPI CLI or a global scanapi.conf file following the XDG Base Directory Specification.

project_name: DemoAPI # This will be rendered in the Report Title.
spec_path: my_path/scanapi.yaml # API specification file path
output_path: my_path/my-report.html # Report output path.
template: my_template.jinja # Custom report template path.