Interaktywna dokumentacja API (Swagger)
Przeglądaj endpointy i wykonuj testowe zapytania bezpośrednio w przeglądarce - z autoryzacją kluczem API.
Ostatnia aktualizacja:
Czym jest Swagger UI?
Swagger UI to interaktywna dokumentacja API BakePilot dostępna w przeglądarce. Jest generowana wprost ze specyfikacji API, więc zawsze pokazuje aktualny stan: wszystkie endpointy, wymagane pola, typy danych i przykładowe odpowiedzi. Możesz z niej też wykonywać prawdziwe zapytania - bez pisania ani linijki kodu.
- Zawsze aktualna lista endpointów i pól - generowana ze specyfikacji
- Przykładowe zapytania i odpowiedzi dla każdego endpointu
- Wykonywanie testowych zapytań prosto z przeglądarki
- Maszynowa specyfikacja OpenAPI pod https://app.bakepilot.pl/api/v1/openapi
Otwórz interaktywną dokumentację API (Swagger) (otwiera się w nowej karcie)
Autoryzacja kluczem API w Swagger UI
Żeby wykonywać zapytania, musisz się autoryzować kluczem API wygenerowanym w Ustawieniach. W Swagger UI służy do tego przycisk „Authorize” w prawym górnym rogu. Klucz możesz podać w polu „bearerAuth” (nagłówek Authorization: Bearer) albo w polu „apiKeyHeader” (nagłówek X-API-Key) - oba działają tak samo.
- W Ustawieniach, w sekcji „Klucze API”, wpisz nazwę i kliknij „Wygeneruj”, potem skopiuj klucz
- Otwórz https://app.bakepilot.pl/api/v1/docs i kliknij „Authorize”
- Wklej klucz w polu „bearerAuth” (lub „apiKeyHeader”) i zatwierdź
- Zamknij okno - od teraz każde zapytanie z dokumentacji jest podpisane Twoim kluczem
Wskazówka: Bez autoryzacji zapytania zwrócą błąd 401. Jeśli widzisz 401 mimo wklejonego klucza - sprawdź, czy skopiowałeś go w całości i czy nie został odwołany w Ustawieniach.
Wykonywanie testowych zapytań
Przy każdym endpoincie jest przycisk „Try it out”. Po jego kliknięciu uzupełniasz parametry lub treść zapytania i klikasz „Execute” - Swagger wysyła prawdziwe zapytanie do API i pokazuje odpowiedź (kod HTTP, nagłówki i JSON). Pamiętaj: to zapytania do prawdziwych danych Twojej organizacji. GET tylko odczytuje, ale POST naprawdę utworzy klienta lub zamówienie.
- „Try it out”, uzupełnij parametry, „Execute”
- Widzisz pełną odpowiedź: kod HTTP i JSON
- GET jest bezpieczny - tylko odczytuje dane
- POST tworzy prawdziwe rekordy w Twojej organizacji
Wskazówka: Zacznij od GET /products albo GET /customers, żeby bezpiecznie sprawdzić autoryzację, zanim przetestujesz tworzenie zamówień.
Najczęściej zadawane pytania
Czy zapytania ze Swaggera działają na prawdziwych danych?
Tak. Swagger wysyła zapytania do tego samego API co Twoje integracje. GET tylko odczytuje dane, ale POST tworzy prawdziwe rekordy (np. zamówienie w statusie Szkic), które zobaczysz w panelu.
Czy potrzebuję konta programisty, żeby otworzyć Swagger?
Nie. Dokumentacja jest publicznie dostępna pod app.bakepilot.pl/api/v1/docs. Do wykonywania zapytań potrzebujesz tylko klucza API wygenerowanego w Ustawieniach.