Ostatnio zajmowałem się implementacją Web API, do jego prezentacji w przeglądarce użyty został Swagger.
Dzisiaj chciałbym 3 kroki, które prowadzą do lepszego udokumentowania takiego API.
Krok 1
Wygeneruj plik dokumentacji Xml na podstawie komentarzy dokumentacyjnych znajdujących się w kodzie.
Ten plik trzeba teraz wskazać w konfiguracji Swagger’a.
Krok 2
Dla operacji typu GET dodaj implementację filtra obsługującego atrybut SwaggerDefaultValue
https://github.com/domaindrivendev/Swashbuckle.WebApi/issues/69
a tak wygląda jego użycie:
Krok 3
Dla operacji typu POST i innych użyj paczki nu-get Swashbuckle.Examples dokładny opis użycia znajdziesz tutaj:
https://mattfrear.com/2016/01/25/generating-swagger-example-requests-with-swashbuckle/
przykład użycia: