Asp.Net Core Web Api 3.1 — Swagger Kullanımı

Swagger açık kaynak ve profesyonel araç seti ile kullanıcılar, ekipler ve işletmeler için API dökümantasyonunu basitleştiren bir araçtır. Swagger’ın API’lerimizi ölçeklendirmemize ve belgelememize nasıl yardımcı araçtır.

1. Paket Kurulumu

Paketi kurmak için iki yol var;

Package Manager Console: Konsolda aşağıdaki komutu çalıştırın.

Install-Package Swashbuckle.AspNetCore

Manage Nuget Packages: Browse sekmesinde Swashbuckle.AspNetCore öğesini arayın ve yükle düğmesine tıklayın.

2. Swagger yazılımının eklenmesi ve yapılandırılması

Startup class’ına kullanmak için aşağıdaki OpenApiInfo sınıfını ekliyoruz:

using Microsoft.OpenApi.Models;

Startup.cs sayfasına aşağıdaki kodları ekliyoruz.

public void ConfigureServices(IServiceCollection services)
{
    .
    .
    .

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo {Title = "Örnek Api", Version = "V1"});
    });
}


public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    .
    .
    .

    app.UseSwagger();

    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My Api V1");
    });
}

Bu kadar! Artık swagger entegrasyonumuz tamamlandı. /swagger web adresine giderek göz atabilirsiniz.