Setup API Sign Up Run Tests Env Vars Hide Info Chaining Requests Nested Endpoints Default Values Include Project Name Custom Report Add to Project

Setup

Welcome to ScanAPI’s tutorial! This tutorial will guide you on how to test and document an API using ScanAPI.

Installation

ScanAPI is a Python library. For installing ScanAPI, you will need:

  • - python version 3.7 or higher
  • - pip, the standard package manager for Python

If you are new to the Python world, no worries, this Installation & Setup Guide can help you with more detailed instructions.

With Python and pip installed, install ScanAPI from the terminal:

$ pip install scanapi

Check that ScanAPI is installed properly:

$ scanapi --version
scanapi, version 2.8.0

The output should return a version equal to 2.8.0 or higher.