Kiedy użyć tego promptu
Gdy planujesz integrację dwóch systemów – sklepu z magazynem, formularza z CRM, aplikacji z płatnościami – i trzeba przekazać programiście jasny opis, co ma powstać. Specyfikacja z endpointami, przykładami żądań i kodami błędów oszczędza tygodnie dopytywania. Prompt nie dopisuje funkcji, których nie ma w materiale.
Przykład
Przykładowe dane do uzupełnienia:
- CEL: przesyłanie nowych zamówień ze sklepu do systemu magazynowego i odbieranie numeru przesyłki
- SYSTEMY: sklep WooCommerce, zewnętrzny system magazynowy (WMS)
- SPOSÓB AUTH: klucz API w nagłówku, osobny dla środowiska testowego i produkcyjnego
- MATERIAŁ: opis procesu: zamówienie opłacone → wysyłka do WMS → WMS zwraca numer przesyłki i status
Czego się spodziewać: Dostaniesz opis endpointów, np. POST /orders z przykładowym body i odpowiedzią, GET /orders/{id}/status, kody błędów (400 przy niepełnych danych, 401 przy złym kluczu), uwagi o idempotencji przy ponownym wysłaniu zamówienia i listę pytań do zespołu, np. co się dzieje przy anulowaniu zamówienia.
Jak dopasować prompt do siebie
- Istniejące API do udokumentowania: wklej kod kontrolerów i poproś o dokumentację w formacie OpenAPI.
- Integracja z zewnętrznym API (np. kuriera): wklej fragmenty jego dokumentacji i poproś o mapowanie pól.
- Specyfikacja dla osoby nietechnicznej: poproś o dodatkowe streszczenie przepływu danych w punktach.
Wskazówki
- Przykłady zawsze na fikcyjnych danych – bez prawdziwych kluczy, adresów i danych klientów.
- Pytania do zespołu rozwiąż przed rozpoczęciem programowania.
- Wersjonuj API od początku (np. /v1/) – zmiany później będą łatwiejsze.
Najczęstsze błędy
- Specyfikacja bez obsługi błędów – integracja działa tylko w idealnych warunkach.
- Dopisywanie endpointów „na przyszłość”, których nikt nie zamawiał.
Co dalej – dopytaj model
Gdy dostaniesz odpowiedź, możesz pójść krok dalej tym poleceniem:
Przygotuj na tej podstawie plik OpenAPI 3.1 i oznacz wszystkie założenia wymagające potwierdzenia.