From 7250ddc07b65999f2424803e0ff511bfd4ce162a Mon Sep 17 00:00:00 2001 From: kankys Date: Sun, 13 Sep 2026 23:44:14 +0200 Subject: [PATCH] updateReadme --- .gitignore | 9 +++++++++ README.md | 24 ++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..59c91ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Ignorování složky node_modules v celém projektu (i v podsloužkách jako apiTest) +node_modules/ + +# Ignorování vygenerovaných HTML a JSON reportů z testů +*.html +*.json +!bruno.json +!package.json +!package-lock.json diff --git a/README.md b/README.md index 5e1388b..53dab89 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# api_test -Repozitář pro testování BE api +## Automated API Testing (Bruno) + +Automatické testování REST API je postaveno na nástroji [Bruno](https://www.usebruno.com/). Testovací kolekce je uložena přímo v repozitáři ve složce `apiTest/PotterAPI` a je verzována společně s kódovým základem. + +### Lokální spuštění testů + +Testy lze spouštět přímo z grafického rozhraní aplikace Bruno, nebo přes příkazovou řádku (CLI). + +#### 1. Pomocí Bruno GUI +1. Otevřete aplikaci Bruno. +2. Zvolte **Open Collection** a vyberte složku `apiTest/PotterAPI` v tomto repozitáři. +3. Spusťte jednotlivé požadavky nebo celou kolekci přes **Runner**. + +#### 2. Pomocí Bruno CLI +Ujistěte se, že běží lokální server (standardně na `http://127.0.0.1:3000`), a spusťte: + +```bash +# Spuštění testů v terminálu +npx @usebruno/cli run apiTest/PotterAPI -r + +# Spuštění testů s vygenerováním HTML reportu +npx @usebruno/cli run apiTest/PotterAPI -r --reporter-html report.html