kontakt
Software house
>
Tag
>
Swagger i automatyzacja dokumentowania API.
swagger rest api

Swagger i automatyzacja dokumentowania API.

Data wpisu
Tomasz Kozon
Autor
Tomasz Kozon

Swagger, czyli OpenAPI umożliwia opisanie REST API za pomocą pliku JSON. Standard ten jest rozumiany przez inne API i deweloperzy z niego korzystający mogą za pomocą standaryzowanego formatu wymieniać pomiędzy sobą informacje, a także tworzyć dokumentację do API do późniejszego zakodowania. Swagger składa się z 3 głównych elementów: Editor, Codegen oraz UI. Każdy z tych elementów pełni szczególną rolę i tak za pomocą edytora możemy generować wizualnie przejrzyste API, za pomocą Codegen możemy generować Server Stuby oraz SDK dla klientów, a za pomocą UI integrować się z naszymi API i generować dla nich dokumentację online, która aktualizowałaby się wraz ze zmianami dokonywanymi w kodzie.

Swagger UI w praktyce


Swagger w praktyce sprowadza się do tego by poprzez integrację z naszym kodem wyświetlić interaktywną dokumentację REST API za pomocą której można testować i wywoływać zapytania. Wszystkie komendy są dokładnie opisane wraz z informacjami, które API przyjmuje, a także zwraca. Bardziej zaawansowane konfiguracje uwzględniają autoryzacje, a także role które są dostępne poszczególnym użytkownikom. Użytkownik typu Admin może widzieć więcej rodzajów zapytań, a użytkownik nie będący Adminem mniej.

Wpisy z tagiem: swagger