ASP.NET Core Web API & Swagger Kullanımı
Bir Web API üzerinde çalışırken, iyi bir API oluşturmak kadar onu basit, kapsamlı ve anlaşılabilir bir şekilde sunabilmekte önemlidir. Bu noktada biz geliştiricilerin yardımına Swagger koşuyor.
Swagger; API tasarım, geliştirme, dokümantasyon ve test aşamalarında bizlere büyük bir kolaylık sağlayan dinamik döküman oluşturma aracıdır.
ASP.NET Core Web API Projemize Swagger Eklemek
Öncelikle Visual Studio üst menüsünden Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution yolunu izledikten sonra çıkan ekranda Browse kısmında “Swashbuckle.AspNetCore” paketini aratıyoruz. Paketi bulduktan sonra dahil etmek istediğimiz projemize ekliyoruz.
Swagger Konfigürasyonu/Yapılandırması
Projemizde Swagger kullanmak için gerekli olan paketi yükledikten sonra, Swagger servisini eklemek için Startup.cs dosyasına giriyoruz ve ConfigureServices metodu içerisinde tanımlıyoruz:
Ardından Configure() metodu içerisinde Swagger’ı etkinleştiriyoruz:
Son olarak başlangıçta Swagger Arayüzümüzü görmek adına projemize sağ tıklayıp Properties alanına giriyoruz. Sol menüden Debug kısmına giriş yaptıktan sonra “Launch browser” kısmını Swagger’a göre düzenliyoruz:
Artık projemize Swagger eklemiş bulunmaktayız. Projeyi ayağa kaldırdığımızda API’mızın dinamik dökümantasyonlarını içeren bir Swagger arayüzüyle karşılacağız:
Bu arayüz üzerinde bir çok işlem yapabilmek mümkün, örneğin metodları test edebilir, kabul edilen parametreleri ve dönüş tipi gibi bilgilerini görebilirsiniz:
Projenin kaynak kodlarına GitHub hesabımdan erişebilirsiniz, kodla kalın! :)
