Interaktywna dokumentacja API (Swagger)

Przeglądaj endpointy i wykonuj testowe zapytania bezpośrednio w przeglądarce - z autoryzacją kluczem API.

Ostatnia aktualizacja: 2026-07-03

Czym jest Swagger UI?

Swagger UI to interaktywna dokumentacja API BakePilot, dostępna w przeglądarce. W przeciwieństwie do opisu tekstowego 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, testowe 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)

Autoryzacja kluczem API w Swagger UI

Żeby wykonywać zapytania, musisz się autoryzować kluczem API (zaczyna się od 'bp_'). Klucz generuje administrator organizacji w Ustawienia → Klucze API. W Swagger UI kliknij przycisk 'Authorize' (u góry strony), wklej klucz w polu 'bearerAuth' i zatwierdź. Alternatywnie możesz użyć pola 'apiKeyHeader' - wtedy klucz jest wysyłany w nagłówku X-API-Key. Od tego momentu wszystkie zapytania wykonywane z dokumentacji będą podpisane Twoim kluczem.

Klucz 'bp_' generujesz w Ustawienia → Klucze API (administrator)
Kliknij 'Authorize' i wklej klucz w polu 'bearerAuth'
Alternatywnie pole 'apiKeyHeader' (nagłówek X-API-Key)
Autoryzacja obowiązuje do zamknięcia lub odświeżenia strony

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.

Wykonywanie testowych zapytań

Przy każdym endpoincie znajdziesz przycisk 'Try it out'. Po jego kliknięciu możesz uzupełnić parametry lub treść zapytania i kliknąć 'Execute' - Swagger wyśle prawdziwe zapytanie do API i pokaże odpowiedź (kod HTTP, nagłówki i JSON). Pamiętaj: to zapytania do prawdziwych danych Twojej organizacji. Zapytania GET tylko odczytują dane, ale POST naprawdę utworzy klienta lub zamówienie (ze statusem roboczym).

'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

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 roboczym), 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.

Powiązane artykuły