Skip to content

Commit a4dc84e

Browse files
camilamaiacamilamaia
authored
Merge pull request #24 from scanapi/23
Improve demo-api example
2 parents 03cd369 + 82699cd commit a4dc84e

25 files changed

+3579
-4153
lines changed

Diff for: ‎demo-api/.env

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
export BASE_URL="http://demo.scanapi.dev/"
1+
export BASE_URL="http://demo.scanapi.dev/api/v1/"
22
export USER="guest"
33
export PASSWORD="demoapi123"

Diff for: ‎demo-api/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,11 @@ $ scanapi run scanapi.yaml
1717
```
1818

1919
The report will be available at `scanapi-report.html`
20+
21+
If you also want to test the csv report, run:
22+
23+
```shell
24+
$ scanapi run -t csv_template.jinja -o scanapi-report.csv
25+
```
26+
27+
The `csv` report will be available at `scanapi-report.csv`

Diff for: ‎demo-api/csv_template.jinja

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
"project_name"{{- "," -}}
2+
"generated_at"{{- "," -}}
3+
"total_successes"{{- "," -}}
4+
"total_failures"{{- "," -}}
5+
"total_errors"{{- "," -}}
6+
"started_at"{{- "," -}}
7+
"total_time"{{- "," -}}
8+
"url"{{- "," -}}
9+
"all_tests_passed"{{- "," -}}
10+
"test_name"
11+
{% for result in results -%}
12+
{% for test in result.tests_results -%}
13+
"{{ project_name }}"{{- "," -}}
14+
"{{ now }}"{{- "," -}}
15+
{{ session.successes }}{{- "," -}}
16+
{{ session.failures }}{{- "," -}}
17+
{{ session.errors }}{{- "," -}}
18+
"{{ session.started_at }}"{{- "," -}}
19+
"{{ session.elapsed_time() }}"{{- "," -}}
20+
"{{ result.response.request.url }}"{{- "," -}}
21+
{{ result.no_failure }}{{- "," -}}
22+
"{{ test.name }}"
23+
{% endfor %}
24+
{%- endfor %}

Diff for: ‎demo-api/scanapi-report.csv

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
"project_name","generated_at","total_successes","total_failures","total_errors","started_at","total_time","url","all_tests_passed","test_name"
2+
"Snippets API","2021-06-11 16:08:42",2,0,0,"2021-06-11 16:08:42.404744","0:00:00.716611","http://demo.scanapi.dev/api/v1/health/",True,"snippets-api::health::status_code_is_200"
3+
"Snippets API","2021-06-11 16:08:42",2,0,0,"2021-06-11 16:08:42.404744","0:00:00.716671","http://demo.scanapi.dev/api/v1/health/",True,"snippets-api::health::body_equals_ok"
4+
"Snippets API","2021-06-11 16:08:42",5,0,0,"2021-06-11 16:08:42.404744","0:00:01.639416","http://demo.scanapi.dev/api/v1/rest-auth/login/",True,"snippets-api::get_token::status_code_is_200"
5+
"Snippets API","2021-06-11 16:08:42",5,0,0,"2021-06-11 16:08:42.404744","0:00:01.639474","http://demo.scanapi.dev/api/v1/rest-auth/login/",True,"snippets-api::get_token::key_in_content"
6+
"Snippets API","2021-06-11 16:08:42",5,0,0,"2021-06-11 16:08:42.404744","0:00:01.639519","http://demo.scanapi.dev/api/v1/rest-auth/login/",True,"snippets-api::get_token::response_time_is_under_a_second"
7+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049335","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::status_code_is_201"
8+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049375","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::response_time_is_under_a_second"
9+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049404","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::url_in_content"
10+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049431","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::id_in_content"
11+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049463","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::highlight_in_content"
12+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049546","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::owner_in_content"
13+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049590","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::title_in_content"
14+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049684","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::code_in_content"
15+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049743","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::linenos_in_content"
16+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049778","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::language_in_content"
17+
"Snippets API","2021-06-11 16:08:42",16,0,0,"2021-06-11 16:08:42.404744","0:00:02.049805","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::create::style_in_content"
18+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561183","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::status_code_is_200"
19+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561226","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::response_time_is_under_a_second"
20+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561261","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::url_in_content"
21+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561297","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::id_in_content"
22+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561378","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::highlight_in_content"
23+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561412","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::owner_in_content"
24+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561439","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::title_in_content"
25+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561466","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::code_in_content"
26+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561492","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::linenos_in_content"
27+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561517","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::language_in_content"
28+
"Snippets API","2021-06-11 16:08:42",27,0,0,"2021-06-11 16:08:42.404744","0:00:02.561543","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::details::style_in_content"
29+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073326","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::status_code_is_200"
30+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073384","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::response_time_is_under_a_second"
31+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073425","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::url_in_content"
32+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073468","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::id_in_content"
33+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073507","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::highlight_in_content"
34+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073546","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::owner_in_content"
35+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073584","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::title_in_content"
36+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073624","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::code_in_content"
37+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073664","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::linenos_in_content"
38+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073703","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::language_in_content"
39+
"Snippets API","2021-06-11 16:08:42",38,0,0,"2021-06-11 16:08:42.404744","0:00:03.073741","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::update_with_patch::style_in_content"
40+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585101","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::status_code_is_200"
41+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585135","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::response_time_is_under_a_second"
42+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585156","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::url_in_content"
43+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585176","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::id_in_content"
44+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585196","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::highlight_in_content"
45+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585215","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::owner_in_content"
46+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585237","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::title_in_content"
47+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585257","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::code_in_content"
48+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585277","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::linenos_in_content"
49+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585296","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::language_in_content"
50+
"Snippets API","2021-06-11 16:08:42",49,0,0,"2021-06-11 16:08:42.404744","0:00:03.585330","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::snippet_update_with_put::style_in_content"
51+
"Snippets API","2021-06-11 16:08:42",50,0,0,"2021-06-11 16:08:42.404744","0:00:04.099079","http://demo.scanapi.dev/api/v1/snippets/232/",True,"snippets-api::snippets::delete::status_code_is_204"
52+
"Snippets API","2021-06-11 16:08:42",51,0,0,"2021-06-11 16:08:42.404744","0:00:04.710953","http://demo.scanapi.dev/api/v1/snippets/",True,"snippets-api::snippets::list_all::status_code_is_200"
53+
"Snippets API","2021-06-11 16:08:42",53,0,0,"2021-06-11 16:08:42.404744","0:00:05.157615","http://demo.scanapi.dev/api/v1/users/",True,"snippets-api::users::list_all::status_code_is_200"
54+
"Snippets API","2021-06-11 16:08:42",53,0,0,"2021-06-11 16:08:42.404744","0:00:05.157654","http://demo.scanapi.dev/api/v1/users/",True,"snippets-api::users::list_all::response_time_is_under_a_second"
55+
"Snippets API","2021-06-11 16:08:42",55,0,0,"2021-06-11 16:08:42.404744","0:00:05.631883","http://demo.scanapi.dev/api/v1/users/2/",True,"snippets-api::users::details::status_code_is_200"
56+
"Snippets API","2021-06-11 16:08:42",55,0,0,"2021-06-11 16:08:42.404744","0:00:05.631921","http://demo.scanapi.dev/api/v1/users/2/",True,"snippets-api::users::details::response_time_is_under_a_second"

0 commit comments

Comments
 (0)