Swagger Kurulumu

Merhabalar bu yazımda .net Core için swagger kurulumunu anlatacağım. Swagger bildiğiniz gibi api dokümantasyonu ve testler sırasındaki kolaylıkları konusunda baya hayat kurtarıcı bir paket. Özellikle farklı ekipler ile paylaşılan bir api yazdığınız durumda işlerinizi çok kolaylaştıracak.

Öncelikli olarak Swashbuckle Package kurulumu yapılması gerekmektedir. Aşağıdaki komutu kullanarak kurulum yapabilirsiniz.

Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc3

Paket kurulumunu gerçekleştirdikten sonra Startup.cs dosyası üzerinde değişiklikler yapılması gerekmektedir.

İlk değişiklik ConfigureServices metodunda yapılacaktır. Yapılacak olan değişikliği aşağıdaki şekilde yapabilirsiniz.

public void ConfigureServices(IServiceCollection services)
{
// Register the Swagger generator, defining 1 or more Swagger documents
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v1”, new OpenApiInfo { Title = “My API”, Version = “v1” });
});
}

İkinci değişiklik Configure metodu içerisinde yapılacaktır.

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseSwagger();
app.UseSwaggerUI(c => { c.SwaggerEndpoint(“/swagger/v1/swagger.json”, “My API”); });
}

Üçüncü değişiklik ise ConfigureServices metodu içerisinde yapılacaktır.

public void ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc(“v1”, new OpenApiInfo { Title = “My API”, Version = “v1” });
});
}

Bu üç değişikliğin yapılmasından sonra artık Startup.cs içerisinde yapılacak değişiklikler tamamlanmış demektir.

Son olarak api içerisinde kullanmış olduğunuz controller’lar için swagger tarafında gözükmesini istediğiniz metodların başına aşağıdaki attribute bilgisini koymanız gerekmektedir. Bunu koymadığınız durumda yine çalışabilir fakat ilgili attribute koyulmadığı durumlarda hata ile karşılaşmanız olası. Bu nedenle kullanmanızı tavsiye ederim.

[HttpPost(“MetodAdı”)]

Yada api için yazmış olduğunuz metod get ise HTTPGet olarak kullanabilirsiniz.

Bu işlemlerin tamamlanmasının ardından apiyi run ettikten sonra yada yayınladıktan sonra main url bilginizin üzerine /swagger/index.html eklerseniz swagger UI bölümüne ulaşmış olacaksınız. Sizi aşağıdaki şekilde bir arayüz karşılayacak.

İlgili arayüz üzerinden ilgili api seçildikten sonra parametre Try Out butonuna tıkladığınız durumda parametre girişine izin verecek ve parametrelerinizi girerek testlerinizi gerçekleştirebilirsiniz.

Bu link bilgisini diğer ekipler ile paylaştığınızda buradaki bilgiler ile sizi daha az meşgul ederek gerekli dokümantasyona ulaşabilir hale geleceklerdir.

Umarım faydalı bir yazı olmuştur.

Teşekkürler…