Pro testování rozhraní OpenAPI jsou k dispozici dvě metody: cURL a Python.
[1] Testování pomocí cURL
- Nastavení: V případě, že je v systému CURL nainstalována funkce CURL, je možné provést nastavení pomocí tzv: Chcete-li zkontrolovat, zda je cURL nainstalován, otevřete Příkazový řádek nebo Terminál a zadejte curl. Pokud se zobrazí chybové hlášení, že cURL nebyl nalezen, postupujte podle pokynů k instalaci, které jsou k dispozici v repozitáři cURL GitHub.
- Provedení prvního požadavku na OpenAPI: Otevřete Příkazový řádek/Terminál a použijte následující příkaz. Nahraďte yyyy-MM-dd datem za posledních 31 dní (kromě aktuálního data) ve formátu yyyy-mm-dd. mydir aktuální cestou ke složce pro stahování ve vašem počítači.
macOS
curl -X POST \
https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download \
-H "Content-Type: application/json" \
-H "X-Authorization: Bearer $OPEN_API_TOKEN" \
-d "{\"device_date\":\"yyyy-MM-dd\"}" \
-o mydir/archive.tar
Windows
curl -X POST ^
https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download ^
-H "Content-Type: application/json" ^
-H "X-Authorization: Bearer %OPEN_API_TOKEN%" ^
-d "{\"device_date\":\"yyyy-MM-dd\"}" ^
-o mydir\archive.tar
Nahraďte "https://api.example.com/endpoint" skutečným koncovým bodem API a "your_api_token" svým tokenem API.
[2] Testování pomocí Pythonu
- Ověřte instalaci Pythonu: Chcete-li zkontrolovat, zda je Python nainstalován, otevřete příkazový řádek nebo terminál a zadejte příkaz 'python'. Pokud se zobrazí chybové hlášení, že Python nebyl nalezen, můžete jej nainstalovat podle pokynů dostupných na oficiálních webových stránkách Pythonu. Ujistěte se, že máte nainstalovaný Python 3.8 nebo novější, abyste mohli používat knihovnu Requests.
- Vytvořte a aktivujte virtuální prostředí:
Vytvořte adresář projektu a virtuální prostředí: Při vytváření virtuálního prostředí v adresáři projektu postupujte podle oficiální dokumentace Pythonu venv.
MacOS
source your-virtual-environment-path/bin/activate
Windows
your-virtual-environment-path\Scripts\activate
Nahraďte your-virtual-environment-path skutečnou cestou k adresáři virtuálního prostředí.