From 3e1d7e5802e50bc57ad4453fe62bc2e7a57bded7 Mon Sep 17 00:00:00 2001 From: Camila Maia Date: Tue, 28 Feb 2023 17:27:27 +0100 Subject: [PATCH] Update `Quick Start` page with new demo api --- docs.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/docs.md b/docs.md index 864b6ff..8ea2df1 100644 --- a/docs.md +++ b/docs.md @@ -29,15 +29,14 @@ For example: ```yaml endpoints: - name: scanapi-demo # The API's name of your API - path: http://demo.scanapi.dev/api/ # The API's base url + path: http://demo.scanapi.dev/api/v1 # The API's base url requests: - - name: list_all_devs # The name of the first request - path: devs/ # The path of the first request + - name: list_all_users # The name of the first request + path: users/ # The path of the first request method: get # The HTTP method of the first request tests: - name: status_code_is_200 # The name of the first test for this request - assert: {% raw %} ${{ response.status_code == 200 }} {% endraw %} # The assertion - + assert: ${{ response.status_code == 200 }} # The assertion ``` And run the scanapi command @@ -50,20 +49,15 @@ Then, the lib will hit the specified endpoints and generate a `scanapi-report.ht

An overview screenshot of the report. A screenshot of the report showing the request details. - A screenshot of the report showing the response and test details

[pip-installation]: https://pip.pypa.io/en/stable/installing/