kankys/api_test
1
0 Fork 0
mirror of https://github.com/LukasKanka/api_test.git synced 2026-11-11 06:34:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add collection guide and test:all:with-backend script

Browse Source 
- Add docs/COLECTION_GUIDE.md with complete guide for creating new collections
- Add test:all:with-backend script for automatic backend + tests execution
- Update README.md with JsonPlaceholder reference and new script info

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
kankys committed 2026-09-15 22:09:35 +02:00
1 parent 8a66fa2760
commit 55626902fe
3 files changed
+268 -1
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+11 -1
View File
@@ -11,6 +11,7 @@ Tento projekt slouží jako **playground** pro vývoj, testování a výuku API
| Služba | Backend | Frontend | Testy | Dokumentace |
|--------|---------|----------|-------|--------------|
| **PotterAPI** | [`backends/potter-api`](./backends/potter-api) | [`backends/potter-api/frontend`](./backends/potter-api/frontend) | [`apiTest/PotterAPI`](./apiTest/PotterAPI) | [bruno_test_scenario.md](./backends/potter-api/bruno_test_scenario.md) |
| **JsonPlaceholder** | ❌ Veřejné API | ❌ | [`apiTest/JsonPlaceholder`](./apiTest/JsonPlaceholder) | - |
---
@@ -51,9 +52,12 @@ Frontend bude dostupný na **`http://localhost:8080`**.
### 4️⃣ Spuštění testů
```bash
# Spuštění všech testů
# Spuštění všech testů (vyžaduje běžící backend pro PotterAPI)
npm run test:all
# Spuštění všech testů + spuštění backendu (automaticky)
npm run test:all:with-backend
# Spuštění pouze PotterAPI testů
npm run test:potter
@@ -61,6 +65,10 @@ npm run test:potter
npm run test:watch
```
> ⚠️ **Poznámka:** Testy pro **PotterAPI** vyžadují běžící backend na `localhost:3000`.
> Testy pro **JsonPlaceholder** fungují bez backendu (používají veřejné API).
> Použij `npm run test:all:with-backend` pro automatické spuštění backendu i testů.
---
## 📁 Struktura monorepa
@@ -169,6 +177,8 @@ Soubor: [`.github/workflows/api-tests.yml`](./.github/workflows/api-tests.yml)
## 📄 Dokumentace
- [PotterAPI – Testovací scénáře](./backends/potter-api/bruno_test_scenario.md) – Detailní průvodce testováním PotterAPI
- [Průvodce vytvářením kolekcí](./docs/COLECTION_GUIDE.md) – Jak přidat novou testovací kolekci
- [Architektura monorepa](./docs/) – Další dokumentace
---