Question 1

How do I handle authentication like OAuth in ScanAPI?

Accepted Answer

ScanAPI supports authentication through headers defined in the YAML/JSON specification, such as tokens or basic auth. For dynamic tokens like OAuth, you may need to pre-process the spec or use environment variables, but it's not built-in.

Question 2

Can ScanAPI test GraphQL APIs?

Accepted Answer

No, ScanAPI is designed specifically for REST APIs. For GraphQL, you'd need to use other tools like GraphQL-specific testing frameworks, as ScanAPI's request structure doesn't accommodate GraphQL queries naturally.

Question 3

ScanAPI vs Postman: which is better for automated testing?

Accepted Answer

ScanAPI excels in fully automated, code-based testing and documentation generation for CI/CD pipelines, while Postman offers a GUI for interactive testing but requires more setup for automation via Newman or scripts.

Question 4

How to integrate ScanAPI with pytest or other Python test frameworks?

Accepted Answer

ScanAPI can be run as a command-line tool from pytest scripts or CI/CD steps, but deep integration with pytest's fixtures or assertion system isn't native; you might need to wrap it in subprocess calls.

Question 5

Does ScanAPI support performance or load testing?

Accepted Answer

No, ScanAPI focuses on functional testing and documentation. It doesn't include performance metrics like response times or concurrency testing; for that, use tools like Locust or JMeter.

Question 6

How to customize the HTML report in ScanAPI?

Accepted Answer

The HTML report uses a default template with limited customization options. The README doesn't provide details on modifying the template, so you might need to edit the source code or use external tools for advanced styling.

scanapi

What is scanapi?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions