Tworzenie REST API. W dobie szerokiej popularności frontendowych frameworków to chyba najpopularniejsze zadanie backendowca. Dotyczy ono jednak całego zespołu, a w produkcji może okazać się zaskakująco… problematyczne.
Wyobraźmy sobie nowy projekt. Zespół jest kompletny. Grafik, frontendowiec, backendowiec a nawet SCRUM Master. Wszystko wygląda pięknie i zapowiada się dobrze. Wtem! Klient wpada na genialny pomysł – zmieńmy nieco architekturę: od teraz to, co zostało już zrobione, ma działać w inny sposób. Aha, mamy na to 3 dni i musimy sie wyrobić! Brzmi znajomo? Cóż zdarza się.
I tu pojawia się Swagger – cały na biało. Kompletny framework do projektowania, prototypowania i dokumentowania API. Za pomocą prostego pliku yaml, lub json możesz znacząco przyśpieszyć i zwiększyć jakość swojej pracy. Zapisanie endpointu ogranicza się więc do zapisania kilku linijek kodu. Podajemy adres, wejściowe dane, możliwe odpowiedzi z serwera i… dokumentacja gotowa. Klika kliknięć więcej i otrzymujemy działający endpoint, zawierający zmockowane dane.
Tak oto frontend może działać bez ostatecznego rozwiązania, a backend bez presji tworzyć wysokiej jakości kod. Na koniec klient nie tylko dostaje to czego chciał, ale też w pełni profesjonalną dokumentację, która… napisała się sama!
Brzmi dobrze? To przejdźmy do konkretów i napiszmy swój pierwszy projekt w Swaggerze.
Czytaj dalej Swagger – czyli jak pisać dokumentację API?