24 Ocak 2019 Perşembe

Asp.Net Core Api - Swagger Kurulumu

Önceki yazılarımda Asp.Net Web Api Swagger kurulumundan bahsetmiştim. Şimdi sıra geldi .Net Core Api için swagger ı kolayca nasıl kurabiliriz ve apimizi dökümante edip kolayca testlerini gerçekleştirebiliriz kısmına.


Aşağıdaki adımları izleyerek .Net Core uygulamamıza swagger kurulumunu yapabiliriz.

1. Sırası ile ilgili menüyü izliyoruz ve Nuget Package Manager ı açıyoruz. Tools > NugetPackageManager > Manage Nuget Package Manager for Solution

2.Arama barına "Swashbuckle.AspNetCore" yazıp aratıyor ve ilk çıkan Nuget Package ı yüklüyoruz.

3. Yükleme tamamlandı şimdi sıra gerekli kodları Startup.cs dosyasına yerleştirip projemizde swagger ı çalışır hale getirme işleminde.

4. Startup.cs dosyamızı açıp aşağıda bold olarak belirtilen kısımlar kod dosyamıza ekleniyor.


       public void ConfigureServices(IServiceCollection services)
        {
            //Swagger döküman tanımını yapıyoruz.
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "WebApplication1", Version = "v1" });
            });

            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }


  // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }

           //swagger kullanımı aktif ediliyor.
            app.UseSwagger();

           //swagger arayüz tanımı yapılıyor.
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web Uygulamamızın Adı");
            });

            app.UseHttpsRedirection();
            app.UseMvc();
        }

İlgili kod dosyamızı son hali aşağıdaki görseldeki gibi olacak.



5. Artık projemiz swagger ile çalışmaya hazır. Projemizi çalıştırıyoruz ve localhost url mize /swagger yazıyoruz ve aşağıdaki gibi bir ekran karşımıza çıkıyor. Artık swagger alt yapısını kullanarak api mizi geliştirmeye devam edebiliriz.