Humorystycznym tytułem, chciałbym przedstawić bibliotekę Swashbuckle, która implementuje narzędzie Swagger.
Swagger jest narzędziem, które dostarcza dokumentację dla naszej usługi, a także formularze testowe dla funkcji API.
Dokumentacja funkcji API opisana jest wg specyfikacji OpenAPI, definiując kontrakty API w stylu REST, opisując zasoby i operacje w czytelnej formie.
Użycie Swagger przedstawię na prostej usłudze ASP.NET Core, która tworzona jest podczas tworzenia nowej usługi.
Dodanie narzędzia Swagger odbywa się kilku prostych krokach:
1. Pobieramy z NuGet paczkę Swashbuckle.AspNetCore
2. W funkcji ConfigureServices dodajemy:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info
{
Title = "Simple Web Service API",
Version = "v1"
});
});
3. A w funkcji Configure:
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Simple Web Service API");
});
W efekcie po uruchomieniu usługi w przeglądarce http://[webserviceurl]/swagger otrzymamy kolorową stronę z dokumentacją API i formularzami testowymi:
Jak widać proces nie jest skomplikowany, a może znacznie ułatwić testowanie usług, jeżeli ktoś nie potrzebuje korzystać z dodatkowych narzędzi, jak Fiddler, etc.