Wiki - Run ScanAPI Locally

[flaviotruzzi]

Hi,

I was following the wiki, it looks like the documentation there is outdated with the current state of the project.

It says:

poetry run scanapi ../examples/pokeapi/scanapi.yaml -c ../examples/pokeapi/.scanapi.yaml -o ../examples/pokeapi/scanapi-report.html

However the example structure does not follow that:

> tree examples/pokeapi
examples/pokeapi/
├── README.md
├── scanapi.conf
├── scanapi-report.html
└── scanapi.yaml

From the help I got it running with:

> poetry run scanapi run examples/pokeapi/scanapi.yaml -c examples/pokeapi/scanapi.conf -o examples/pokeapi/scanapi-report.html
Loading file examples/pokeapi/scanapi.conf
Loading file examples/pokeapi/scanapi.yaml
Writing documentation
Making request GET https://pokeapi.co/api/v2/pokemon
Making request GET https://pokeapi.co/api/v2/pokemon/bulbasaur

The documentation was generated successfully.
It is available at /home/[omitted]/examples/pokeapi/scanapi-report.html

Did I miss something?

[marcuxyz]

You really are super right! This will be corrected ...

as documentation:

with fixed: