Project Name

You can add a title to your report, this way you can easily differentiate reports from different APIs. To do so, we need to set the project_name in the configuration file scanapi.conf:

project_name: Snippets API

Putting it all together:

project_name: Snippets API
report:
  hide_request:
    body:
      - password
    headers:
      - Authorization
  hide_response:
    body:
      - key

Run ScanAPI again and reload the report:

$ scanapi run

Report overview - project name

You can check all the possible settings you can set for your project at our Configuration File Doc.

Ok, but what if you don’t like the style of our report? Or if some information you’d like to see is missing? Or even if you need the report in another format other than html? Don’t worry, let’s see how can you create your own ScanAPI report.