A
api-development
Develop and extend NetAlertX REST API endpoints. Use this when asked to create endpoint, add API route, implement API, or modify API responses.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Develop and extend NetAlertX REST API endpoints. Use this when asked to create endpoint, add API route, implement API, or modify API responses.
How to use
- Zlokalizuj punkt wejścia aplikacji Flask w pliku server/api_server/api_server_start.py — to główny plik, w którym rejestrowane są wszystkie trasy API.
- Przygotuj nowy endpoint w katalogu server/api_server/, decydując, czy będzie to operacja na pojedynczym urządzeniu, zbiorowa operacja na liście urządzeń, czy funkcjonalność pomocnicza (np. narzędzia sieciowe, metryki, synchronizacja).
- Dodaj autoryzację do każdego endpointa, wymagając nagłówka Authorization: Bearer z tokenem API — pobierz token za pomocą get_setting_value('API_TOKEN').
- Zaimplementuj odpowiednią strukturę odpowiedzi: zwróć {"success": true, "data": wynik} dla powodzenia lub {"success": false, "error": "opis błędu"} dla błędu. Wyjątek stanowi legacy endpoint /device/
GET, który zachowuje starą strukturę dla zgodności z interfejsem użytkownika. - Przetestuj endpoint, upewniając się, że zwraca poprawny kod HTTP i strukturę JSON zgodnie z kontraktem odpowiedzi.
- Jeśli endpoint zmienia dane, zaktualizuj interfejs użytkownika, aby czytał i zapisywał cache JSON zgodnie z nową trasą API.