Skip to content

Commit 864d8cd

Browse files
authored
Update Quick Start page with new demo api (#93)
1 parent 2eb9531 commit 864d8cd

1 file changed

Lines changed: 6 additions & 12 deletions

File tree

docs.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,14 @@ For example:
2929
```yaml
3030
endpoints:
3131
- name: scanapi-demo # The API's name of your API
32-
path: http://demo.scanapi.dev/api/ # The API's base url
32+
path: http://demo.scanapi.dev/api/v1 # The API's base url
3333
requests:
34-
- name: list_all_devs # The name of the first request
35-
path: devs/ # The path of the first request
34+
- name: list_all_users # The name of the first request
35+
path: users/ # The path of the first request
3636
method: get # The HTTP method of the first request
3737
tests:
3838
- name: status_code_is_200 # The name of the first test for this request
39-
assert: {% raw %} ${{ response.status_code == 200 }} {% endraw %} # The assertion
40-
39+
assert: ${{ response.status_code == 200 }} # The assertion
4140
```
4241
4342
And run the scanapi command
@@ -50,20 +49,15 @@ Then, the lib will hit the specified endpoints and generate a `scanapi-report.ht
5049

5150
<p align="center">
5251
<img
53-
src="https://raw.githubusercontent.com/scanapi/scanapi/master/images/report-print-closed.png"
52+
src="https://raw.githubusercontent.com/scanapi/scanapi/main/images/report-print-closed.png"
5453
width="700"
5554
alt="An overview screenshot of the report."
5655
>
5756
<img
58-
src="https://raw.githubusercontent.com/scanapi/scanapi/master/images/report-print-request.png"
57+
src="https://raw.githubusercontent.com/scanapi/scanapi/main/images/report-print-opened.png"
5958
width="700"
6059
alt="A screenshot of the report showing the request details."
6160
>
62-
<img
63-
src="https://raw.githubusercontent.com/scanapi/scanapi/master/images/report-print-response.png"
64-
width="700"
65-
alt="A screenshot of the report showing the response and test details"
66-
>
6761
</p>
6862
6963
[pip-installation]: https://pip.pypa.io/en/stable/installing/

0 commit comments

Comments
 (0)