Usługa Swaggera jest opcjonalna i można ją włączyć za pomocą konfiguratora webapi zaznaczając checkbox w nowym wierszu na zakładce WebAPI w wierzszu Swagger UI dla WebApi.
Po włączeniu opcji, należy uruchomic WebAPI. Po wystartowaniu usługi Swagger UI jest dostepne pod url: /swagger/ui/index
Większość endpointów WebApi wymaga otwartej sesji użytkownika do poprawnego działania.
W celu otwarcia sesji w SwaggerUI nalezy wybrać metodę : Get /api/Session/OpenNewSession, oraz w polu Authorization wpisać token aplikacji WebApi w formacie Application TOKEN.
Wygenerowany token w Response Body należy umieścić u góry strony w polu Api Key w formacie Session <TOKEN>, jest to identyfikator sesji który zostanie automatycznie przekazany przy wywoływaniu pozostałych endpointów.
Dodawanie dokumentacji swoich modułów do Swagger UI
Ponieważ integracja z Swaggerem powinna służyć wszystkim użytkownikom, automatycznie dokumentowane są wszystkie załadowane moduły. Twórcy modułów mogą dodać do nich czytelne opisy, w tym celu endpointy kontrolerów powinny zostać opatrzone komentarzami w formacie tagów dokumentacji Recommended XML documentation tags - C# reference | Microsoft Learn.
Wygenerowane pliki .xml dla każdego modułu wystarczy umieścić w nowym podkatalogu programu webapi /Resources/Docs, aby swagger automatycznie wyświetlił opisy przy endpointach. Warunkiem koniecznym jest żeby plik .xml miał taką samą nazwę jak plik .dll modułu. System jest zaprojektowany tak, żeby był uniwersalny dlatego w folderze /Resources/Docs znajdują się również pliki .xml dla modułów Symfonii.
