Swagger API test arayüzü kullanımı

Merhabalar bu yazıda Swagger kullanımına dair birkaç temel not paylaşmak istiyorum. Öncelikle Swagger nedir? Bu soruya cevap verdikten sonra sizlere Swagger kurulumunu basit bir şekilde aktarmaya çalışacağım.

Eminim ki aranızda bu yazıyı okuyanların çoğu API kavramına aşinadır hatta birçoğunuz API’ler ile çalışıyordur. Eğer ASP.NET Core’da API geliştiriyorsanız Swagger sizin işinize oldukça yarayacaktır. Birçoğumuzun API’leri test etmek için kullandığı program olan POSTMAN’i çoğunuz bilirsiniz. Swagger dediğimiz framework bizlere Postman’i gereksiz hale getiren bir framework. API’mizin kendi içerisine bir arayüz kurarak GET, POST, DELETE, UPDATE gibi işlemleri yapmanızı sağlayan, API’nin metotlarını kod içerisinde dokümante edebildiğiniz bir framework. Bunun örneklerini sizlere uygulamalı olarak göstermeye çalışacağım.

Öncelikle ASP.NET Core Web API uygulamamızı oluşturuyoruz.

Sonrasında ise yapmamız gereken ilk şey aşağıda seçili olan “Swashbuckle.AspNetCore” adlı NuGet paketini yüklemek.

Gerekli NuGet paketini yükledikten sonra proje içerisindeki Startup.cs dosyamıza gidiyoruz ve buraya bir servis ve iki adet konfigürasyon ekliyoruz.

Servis kodları aşağıdadır:

services.AddSwaggerGen(setupAction =>

{

setupAction.SwaggerDoc("LibraryOpenAPISpecification",

new Microsoft.OpenApi.Models.OpenApiInfo()

{

Title = "API ADINIZ",

Version = "1"

});

});

Konfigürasyon kodları ise aşağıdadır.

app.UseSwagger();

app.UseSwaggerUI(setupAction =>

{

setupAction.SwaggerEndpoint(

"/swagger/LibraryOpenAPISpecification/swagger.json",

"API ADINIZ");

});

Bütün bu işlemlerden sonra projenizin çalıştırınca projenizin ip’sinden sonra swagger yazarsanız direkt arayüze gidecektir. Mesela projenizin adresinin localhost:44359 olduğunu varsayarsak localhost:44359/swagger adresi sizi Swagger API test arayüzü uygulamasına götürecektir.

Burada projenizde olan tüm API metotları otomatik olarak listelenecek ve test edilebilir olacaktır.

Bu kısa yazıda sizlere Swagger Arayüzü’nün eklenmesinden bahsettim. Bir sonraki yazıda ise dokümantasyon işlemlerinin nasıl ve hangi metodoloji ile yapıldığından bahsetmeye çalışacağım.

İyi çalışmalar ve esenlikler dilerim.

Abdullah Faruk ÇİFTLER