Bu makale, NET Core ve Swagger'ın ne olduğunu ve nasıl kullanılabileceğini açıklamaktadır NET Core, modüler ve çok platformlu bir uygulama çerçevesidir ve Windows, Linux ve macOS gibi pek çok işletim sistemi ile uyumlu çalışabilir Swagger ise API'lerin belgelenmesi ve test edilmesi için kullanılan açık kaynaklı bir araçtır NET Core ve Swagger, uygulama geliştirme ve belgeleme süreçlerini kolaylaştırarak zaman ve maliyet tasarrufu sağlar NET Core, açık kaynak kodlu, daha hafif ve diğer NET Framework'lere göre daha hızlıdır Swagger API'lerin belgelenmesi, test edilmesi ve kullanıcı dostu bir arayüz aracılığıyla görsel olarak sunulması için kullanılır Swagger UI, API geliştiricilerine birçok özelleştirme seçeneği sunarak API'larının daha etkili bir şekilde geliştirilmesine yardımcı olur

Bugünkü makalemizde, .NET Core ve Swagger'ın ne olduğunu ve nasıl kullanıldığını ele alacağız. .NET Core Microsoft'un açık kaynaklı, modüler ve çok platformlu bir uygulama çerçevesidir. .NET Core, Windows, Linux ve macOS işletim sistemleri için uygulamalar geliştirmemize olanak sağlar. Swagger ise API'lerimizin belgelenmesi ve test edilmesi için açık kaynaklı bir araçtır.
.NET Core ile uygulama geliştirirken Swagger, API'lerimizin açık ve anlaşılması kolay belgelerini ve testlerini oluşturmanıza yardımcı olur. Swagger ile API belgeleri, kullanıcı dostu bir arayüze sahip Swagger UI tarafından otomatik olarak oluşturulur. DotNet Core ve Swagger kullanımı hem geliştirme hem de belgeleme sürecini kolaylaştırarak, süreci hızlandırarak zaman ve maliyet tasarrufu sağlar.
.NET Core Nedir?
.NET Core, açık kaynaklı, şematik ve Cross-Platform bir framework'dür. .NET Core, .NET'in son sürümüdür ve Eski .NET Framework'a benzer, ancak daha hafif bir yapıya sahiptir. .NET Core, birden fazla işletim sistemi, cihaz ve buluta uyum sağlar. Ayrıca .NET Core, hareket halindeyken güncelleştirilebileceği ve snapshot'lara sahip olabileceği için şirketler için büyük bir avantajdır.
.NET Core'un birçok avantajı vardır. İlk olarak, açık kaynak kodlu bir platform olduğu için, istedikleri şekilde değiştirip kullanabilecekleri bir çok kaynak kodu depolamasına izin verir. İkinci olarak, .NET Core Cross-Platform bir platformdur, bu nedenle mobil cihazlar, masaüstü uygulamaları, IoT cihazları, bulutlar, vb. gibi her türlü cihazda kullanılabilir. Son olarak, .NET Core, .NET Framework'a kıyasla daha hızlı bir framework'tür ve .NET Foundation'ın sürekli bir şekilde iyileştirmeler ve güncellemeler ekleyerek daha da geliştirmeye devam ettiği bir yapıya sahiptir.
.NET Core kullanarak uygulama geliştirirken, birden fazla programlama dili kullanabilirsiniz. Bunlardan en popülerleri C #, VB.NET, F # ve C ++ 'dır. .NET Core, kendine özgü bir proje yapısına sahiptir ve projeler ilk oluşturulduklarında muhtemelen iki önemli dosyaya sahip olacaklardır; projenin düzenlendiği csproj dosyası ve proje katmanına ait sınıfların bulunduğu Program.cs dosyası. Bu açıdan, .NET Core kullanmak daha da kolaylaşmaktadır.
- Daha hafif, esnek ve Cross-Platform tabanlı,
- Açık kaynak kodlu bir platformdur,
- Birden Fazla Programlama Dili Kullanabilir,
- Birden Fazla İşletim Sistemi ile Uyumlu,
- Snapshot alabilir & Güncellenebilir,
- Hareket halindeyken güncelleştirilebilir.
.NET Core 'in kullanımı oldukça kolaydır. .NET Core'in yüklenmesi birkaç basit adımdan oluşur ve işletim sisteminize bağlı olarak aşağıdaki bileşenler yüklenir:
Platform | Yükleme |
---|---|
Linux | apt-get veya yum veya rpm yetenekli paket yöneticisi aracılığıyla yükleme |
Windows | .NET Core yükleyicisi kullanılarak yükleyin. |
MacOS | Birkaç adımda yükleyin |
Swagger Nedir?
Swagger, API hizmetlerinin belgelenmesi ve test edilmesi için web tabanlı bir araçtır. API servisleri kodlamadan önce API hizmetinin eksiksiz belgelenmesini sağlamak üzere kullanılır. Swagger, API servislerini hızlı bir şekilde test etmek, küçük değişiklikler yapmak ve yeni API servislerini kolayca oluşturmak için kullanılır.
Swagger, Swagger UI ve Swagger kod üreteci olmak üzere iki ana bileşenden oluşur. Swagger UI, geliştiricilerin API hizmetlerinde gezinmelerine, API hizmetlerini görüntülemelerine ve test etmelerine olanak tanıyan güzel bir arayüzdür. Swagger kod üreteci, API bizim için otomatik olarak bir SDK veya dokümantasyon oluşturur.
- Swagger API Hizmetlerinin belgelenmesini ve test edilmesini sağlar.
- Swagger UI, API hizmetlerini görüntülemek, test etmek ve mimarisi hakkında bilgi edinmek için kullanılır.
- Swagger kod üreteci, API hizmetleri için SDK veya dokümantasyon otomatik olarak oluşturur.
Swagger Özellikleri | Açıklama |
---|---|
API servislerinin belgelenmesi | API servislerinin tanımlanması, yönlendirilmesi, doğrulanması ve belgelenmesine izin verir. |
API servislerinin test edilmesi | API hizmetlerinin kolayca ve hızlı bir şekilde test edilmesine olanak tanır. |
API servislerinin otomatik dokümantasyonu | API hizmetlerinden otomatik olarak dokümantasyon oluşturur. |
Swagger UI Nedir?
Swagger, RESTful API'leri belgelemek ve test etmek için kullanılan bir araçtır. Swagger UI ise Swagger belgelerini görsel olarak sunan bir web arayüzüdür. Bu arayüz sayesinde API kullanıcılarına API'lar hakkında ayrıntılı bilgi sağlanır ve API'ların nasıl kullanılacağına dair örnekler sunulur. Swagger UI, API geliştiricilerinin API'larını daha da geliştirmelerine yardımcı olmak amacıyla birçok özellik sunar.
- API etkileşimlerinin test edilmesi
- API değişikliklerinin kolay bir şekilde takip edilmesi
- API geliştiricilerinin API'ları hakkında geri bildirim almasına yardımcı olması
- API belgelerinin kullanıcı dostu bir şekilde sunulması
Swagger UI, RESTful API'lerin belgelenmesi için birçok özelleştirme seçeneği sunar. Örneğin, kullanıcıların API'ları test etmelerine olanak tanıyan özel form alanları ve özelleştirilmiş temalar gibi özellikler sunar. Swagger UI ayrıca, API'ların nasıl kullanılacağına dair örnekler ve açıklamalar içeren API unit testlerinin oluşturulmasına da olanak tanır. Bu sayede, API kullanıcıları, API'lar hakkında daha fazla bilgi edinebilir ve API geliştiricileri, API'larının daha da geliştirilmesi için geri bildirimler alabilirler.
Swagger UI Özellikleri Nelerdir?
Swagger UI, açık kaynaklı bir araçtır ve API geliştiricileri tarafından API'lerini test etmek, paylaşmak ve belgelemek için kullanılır. Bu nedenle birçok işlevselliği bulunur. Swagger UI'nin temel özellikleri şunlardır:
- API Dökümantasyonu: Swagger UI sayesinde kullanıcılara API dökümantasyonları açık bir şekilde sunulur. Bu dökümantasyonlar sayesinde, kullanıcılar geliştirme işlemlerine hızlı bir şekilde başlayabilirler.
- API Test Etme: Swagger UI, API geliştiricilerinin geliştirdiği API'leri test edebilmelerini sağlar. Bu özellik API'lerinin doğru şekilde çalıştığını ve doğru sonuçlar verdiğini doğrulama konusunda oldukça faydalıdır.
- API Paylaşma: Swagger UI, API'lerin paylaşılmasını kolaylaştırır. API dokümantasyonlarının tamamı burada bulunur, bu nedenle diğer geliştiriciler tarafından kolayca erişilebilir.
Swagger UI aynı zamanda geliştiricilerin fiyatlandırma bilgileri, API'nin desteklediği veri türleri, yanıtların formatı, sürümler, endüstri standartları ve diğer API özelliklerine erişimlerini de sağlar. Kullanıcılar API kullanımları hakkında detaylı bilgi alabilirler ve bunların yanı sıra Swagger UI, API'nin performansını arttırmak için özelleştirilebilir. Örneğin, Swagger UI'yi kendi gereksinimlerinize uygun bir şekilde özelleştirebilirsiniz. Bu sayede kullandığınız API'lerin daha rahat bir şekilde test edilmesi ve belgelenmesi mümkün hale gelecektir.
Swagger UI Nasıl Özelleştirilir?
Swagger UI özelleştirmek oldukça kolaydır ve bu sayede dokümantasyonunuz daha görsel ve işlevsel hale gelebilir. Swagger UI tasarımı, Swagger UI dosyalarınızı düzenleyerek veya Swagger UI yapılandırmasını değiştirerek özelleştirilebilir. Swagger UI'ı özelleştirmeden önce, HTML, CSS ve JavaScript dilleri hakkında bir miktar bilgi sahibi olmanız gerektiğini unutmayın.
Swagger UI'da yapılandırılabilen birkaç özellik vardır. Bu özelliklerden bazıları şunlardır:
- Ana renk
- Başlık
- Logo
- Favicon
- Auth özellikleri
Öncelikle, Swagger UI tasarımı özelleştirmek için 'swagger-ui.css' dosyasını düzenlemeniz gerekebilir. Bu dosyada tüm renk, tipografik ve düzenleme özellikleri vardır. Örneğin, body bölümündeki background-color: #2b2e37; kod satırını değiştirerek ana arka plan renginizi özelleştirebilirsiniz.
Başlık, logo ve favicon özelleştirme işlemleri ise "index.html" dosyasında yapılır. Bu dosyaya erişmek için, Swagger UI dizinindeki "dist" klasörüne gidin ve bu dosyayı düzenleyin. "title" etiketi, Sayfa başlığını belirlerken "img" etiketi ile logosunu değiştirebilirsiniz. Favicon'u değiştirmek için HTML header içerisinde "link" etiketi kullanılır.
Auth özelliklerini özelleştirmek için Swagger UI dizinine gitmeniz ve 'swagger-config.json' dosyasını açmanız gerekir. Bu dosya, API'larınızda kullanılacak tüm özelliklerin yer aldığı dosyadır. "securityDefinitions" bölümünde kullanıcı adı ve şifre ile kimlik doğrulama yapmayı etkinleştirebilirsiniz.
Tüm bu işlemleri tamamladıktan sonra, dokümantasyonunuzu Swagger UI üzerinden görüntülerken özelleştirilmiş tasarımınızı görebilirsiniz.
Swagger Kod Üretme
Swagger, RESTful API'lerin dökümantasyonunu oluşturmak ve test etmek için bir araçtır. Ayrıca Swagger, birçok programlama dili için kod oluşturma işlemine de olanak tanımaktadır. Swagger Codegen aracı kullanılarak, API belirleme dosyasında (JSON veya YAML formatında) tanımlanan API'lerden farklı programlama dilleri için müşteri/istemci ve sunucu kodu üretilebilir. Bu sayede geliştiriciler, API'yi kullanmak istedikleri dillerde ortak bir yapıya sahip kodlar yazarak zaman ve iş gücünden tasarruf edebilirler.
Desteklenen Diller | Kod Üretme Komutları |
---|---|
Java | java -jar swagger-codegen-cli.jar generate -i [input swagger file] -l java -o [output directory] |
C# | java -jar swagger-codegen-cli.jar generate -i [input swagger file] -l csharp -o [output directory] |
Python | java -jar swagger-codegen-cli.jar generate -i [input swagger file] -l python -o [output directory] |
Go | java -jar swagger-codegen-cli.jar generate -i [input swagger file] -l go -o [output directory] |
Swagger Codegen aracını kullanarak kod oluşturma işlemi çok basittir. Öncelikle kod üretmek istediğimiz programlama dilini ve output dizinini belirlemek gerekmektedir. Daha sonra Swagger belirleme dosyasının yolu (input swagger file) belirtilerek üretilecek kodlar oluşturulabilir. Yukarıdaki tabloda, Swagger Codegen aracının desteklediği diller ve her bir dili için nasıl kod üretileceği komutları gösterilmiştir.
Bununla birlikte, Swagger Codegen aracı ile elde edilen kodlar yalnızca bir başlangıç noktasıdır. Bu kodlar, sonraki süreçlerde iyileştirilerek istenen özelliklerin eklenmesi gerekebilir. Ancak, Swagger Codegen aracının sağladığı hızlı ve doğru bir başlangıç sayesinde geliştiriciler, API yazma süreçlerini hızlandırabilir ve daha verimli hale getirebilirler.
.NET Core ve Swagger Kullanımı
.NET Core ve Swagger, aplikasyonlar ve mikroservislerin geliştirilmesi için sıklıkla kullanılan araçlardan ikisidir. .NET Core, çok platformlu bir .NET uygulama geliştirme çerçevesidir. Swagger ise, açık kaynak bir araçtır ve yüksek kalitede RESTful web servislerinin tasarımı, yapılandırılması ve dokümantasyonu için kullanılan bir çözümdür.
.NET Core ve Swagger'ın birlikte kullanımı, RESTful web servislerin geliştirilmesi sürecinde oldukça popülerdir. Swagger, servisleri dokümante ederken, .NET Core ise bu servisleri hızlı ve kolay bir şekilde geliştirmenize izin verir. Örnek olarak, bir .NET Core uygulaması oluştururken Swagger'da bir API dökümantasyonu oluşturabilirsiniz. Bu yöntemle, uygulamanızı dökümantasyon olmadan gerçekleştirdiğinizden daha hızlı ve daha kolay bir şekilde geliştirebilirsiniz.
.NET Core ile API oluşturma adımları kolaydır ve Swagger ile nasıl entegre edileceği de oldukça basittir. İlk olarak, Visual Studio kullanarak .NET Core projesi oluşturunuz ve daha sonra API kodunuzu yazın. API'niz hazır olduğunda, Swagger'ı yükleyin ve yapılandırın. Bu işlemi tamamladıktan sonra, Swagger UI'ını kullanarak API'nizi test edebilir ve dökümantasyonunu kolayca oluşturabilirsiniz.
.NET Core API dökümantasyonu, Swagger kullanarak kolayca oluşturulabilir. Swagger, API'nizin dökümantasyonunu otomatik olarak oluşturacak JSON belgelerini üretir. Bu belgeleri, Swagger UI ile kolayca kullanabilirsiniz. Swagger, API'nizin URI'ları, tanımları ve parametrelerini açıklayan bir dokümantasyon sayfası oluşturacaktır.
.NET Core ve Swagger birbirinin tamamlayıcılarıdır. Swagger, RESTful web servislerinin tasarımı, yapılandırılması ve dokümantasyonu için kullanılırken, .NET Core hızlı ve güvenli bir şekilde uygulama geliştirmeyi sağlar. Bu iki aracın birlikte kullanımı, hızlı uygulama geliştirmeye ve yüksek kalitede API dökümantasyonuna olanak sağlar.
API Oluşturma
.NET Core, API (Application Programming Interface) oluşturma işleminde gereksinim duyduğumuz teknolojiler arasında yer almaktadır. .NET Core kullanarak API oluşturmak oldukça kolaydır. İlk olarak .NET Core yüklü olduğundan emin olunmalıdır. Visual Studio veya komut satırı aracılığı ile yeni bir .NET Core projesi oluşturduktan sonra, API'yi tasarlamak için kontroller ve rotalar eklemek gereklidir.
Swagger ile .NET Core API'sini entegre etmek oldukça basittir. Swagger UI, API'nin sunduğu rotaların dökümantasyonunu gösterir. Swagger, "Microsoft.AspNetCore.Mvc.ApiExplorer" ve "Swashbuckle.AspNetCore" gibi paketlerin yüklü olması gerektiğini unutmayın. Paketler yüklendikten sonra, Startup dosyası açılarak "services.AddSwaggerGen(); services.AddSwaggerUi();" kodları eklenmelidir. API Controller sınıfına sahipseniz, Swagger UI'ın çalışması için XML belgelerini etkinleştirmelisiniz. Bu adımları tamamladıktan sonra, Swagger UI'ı bir tarayıcıda açarak API rotalarınızın dökümantasyonunu görebilirsiniz.
Ayrıca, Swagger UI özelleştirmek de mümkündür. Örneğin renkler, açıklamalar ve logo gibi öğeleri düzenleyebilirsiniz. Swagger, API rotalarında kullanılan verileri json veya yaml olarak kod oluşturmak için de kullanılabilir. Bu sayede, programcılar rotaları kullanarak uygulama oluşturabilir.
API'sini oluşturmak ve Swagger ile entegre etmek isteyenler öncelikle .NET Core'ı öğrenmeli ve temel API oluşturma adımlarını uygulamalıdırlar. Daha sonra, Swagger ve .NET Core'u birlikte kullanarak API'lerini dökümante edebilirler. API dökümantasyonu, API'nin anlaşılabilir olmasını sağlar ve API'nin diğer geliştiricilere kolayca kullanımını sağlar.
API Dökümantasyonu
API dökümantasyonu, bir API'nın ne yaptığını ve kullanımını anlatan belgelerdir. Bu belgeler, API'nın nasıl kullanılacağı, hangi istekleri kabul edeceği, hangi yanıtları vereceği ve hangi hataları gönderebileceği hakkında detaylı bilgi içerir.
Swagger kullanarak .NET Core API dökümantasyonu yapmak oldukça kolaydır. Swagger, API'ları otomatik olarak belgelendirmek için tasarlanmış bir araçtır. Swagger doğrudan API koduna dokunmaz, ancak API'ye HTTP istekleri göndererek sonuçları dökümantasyon olarak çıktı olarak alır.
Swagger dökümantasyonu oluşturmak için öncelikle API kodunda Swagger özelliklerini etkinleştirmek gerekiyor. Swagger, API koduna birkaç özellik ekler ve bu özellikler web API'nin OpenAPI (Swagger Spec) belgesine dönüştürülmesini sağlayacak şekilde yapılandırılır. Daha sonra Swagger UI, API belgelerine göz atmak için bir web arayüzü sağlar.
Aşağıdaki adımlar yardımıyla .NET Core API'nız için Swagger dökümantasyonunu oluşturabilirsiniz:
1. Swagger dökümantasyonunu oluşturma eklentisini yükleyin: Öncelikle, .NET Core API'nın Swagger desteğini etkinleştirmek için Swagger eklentisini yüklemelisiniz. Eklentiyi yüklemek için paket yöneticisini veya NuGet konsolunu kullanabilirsiniz.
2. Swagger özelliklerini yapılandırın: Swagger, özelliklerini özelleştirerek API dökümantasyonunu şekillendirmenize olanak tanır. Örneğin, API adını, açıklamasını, logo URL'sini vb. belirleyebilirsiniz. Bu özellikler genellikle Startup.cs dosyasının ConfigureServices () yönteminde yapılandırılır.
3. Swagger UI'ı yapılandırın: Swagger UI, API dökümantasyonunu görüntülemek için kullanılır. Varsayılan olarak, Swagger UI, /swagger yolunu kullanarak açılır. SwaggerUI ayarlarını yapılandırarak, API dökümantasyonunu özelleştirebilir ve özelleştirilmiş bir görünüm sağlayabilirsiniz.
4. API dökümantasyonunu oluşturun: Swagger, API dökümantasyonunu oluşturmak için API endpoint'lerine HTTP istekleri gönderir. Bu istekler sonuçları JSON veya YAML biçiminde dönüştürür ve belgeleri oluşturmak için kullanır.
.NET Core ve Swagger'ı kullanarak API dökümantasyonu oluşturmak oldukça kolaydır. Swagger, kodunuzu etkilemeden API dökümantasyonunu otomatik olarak oluşturmanıza olanak tanır ve API'nızın nasıl kullanılması gerektiği hakkında tüm gerekli bilgileri içeren bir belge oluşturur.
Swagger'ı .NET Core'a Entegre Etme
.NET Core uygulamanıza Swagger'ı eklemek oldukça kolaydır. Swagger'ın kurulumu ve yapılandırması adımlarını takip ederek bunu gerçekleştirebilirsiniz.
Öncelikle, Swagger'ın kurulumu için NuGet paketi yöneticisini kullanmanız gerekmektedir. Terminalinizde aşağıdaki komutu kullanarak Swagger'ı yükleyebilirsiniz:
dotnet add package Swashbuckle.AspNetCore |
Swagger'ın .NET Core API'larına entegre edilmesi için, Startup.cs dosyasında gerekli ayarlar yapılmalıdır.
ApplicationBuilder'ın Configure() yönteminde Swagger UI'ı etkinleştirmek, Swagger JSON verilerine erişmek ve Swagger'ı kullanarak API'ı dökümanlamak için gerekli olan Swagger middleware eklentilerini tanımlamalısınız. Aşağıdaki kod örneğinde, Swagger'ın .NET Core API'larına nasıl entegre edileceği adım adım açıklanmıştır:
using Microsoft.AspNetCore.Builder;using Microsoft.AspNetCore.Hosting;using Microsoft.Extensions.Configuration;using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Hosting;using Microsoft.OpenApi.Models;namespace MyAPI{ public class Startup { public IConfiguration Configuration { get; } public Startup(IConfiguration configuration) { Configuration = configuration; } public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "MyAPI", Version = "v1" }); }); } public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseHttpsRedirection(); app.UseRouting(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyAPI V1"); }); } }} |
Bu adımların tamamlanmasıyla birlikte artık .NET Core API'larınızda Swagger kullanmaya hazırsınız.
Swagger'ın .NET Core'a Kurulumu
Swagger, .NET Core ile uyumlu bir şekilde kullanılabilmektedir. Swagger'ı .NET Core'a kurmak oldukça basittir. Swagger, .NET Core'un ön belleğe alınması veya bağımlılık yöneticisi paketleri kullanılarak yüklenmesi gibi farklı yöntemlerle yüklenebilir.
Swagger'ı .NET Core'a yüklemek için ilk önce Visual Studio veya Visual Studio Code gibi bir derleyiciye sahip olmanız gerekmektedir. Daha sonra, .NET Core projesinin bulunduğu klasöre gidin ve terminale aşağıdaki komutu yazın:
dotnet add package Swashbuckle.AspNetCore
Bu komut Swagger'ı .NET Core projesine yükleyecek ve projenin bağımlılıklarına Swashbuckle.AspNetCore paketinin eklenmesini sağlayacaktır. Alternatif olarak, Visual Studio veya Visual Studio Code'un paket yöneticisi arayüzünden de Swagger yüklenebilir. Bunun için, paket yöneticisi arayüzünden "Swashbuckle.AspNetCore" aranmalı ve yükleme işlemi gerçekleştirilmelidir.
Swagger'ın .NET Core'a kurulumu tamamlandığında, proje yapısında buna ilişkin değişiklikler yapılması gerekmeyecektir. Swagger, .NET Core projesine eklendikten sonra swagger.json dosyası otomatik olarak oluşturulur ve API dökümantasyonu Swagger UI ile görüntülenebilir hale gelir.
Swagger'ın .NET Core'a Entegrasyonu
Swagger'ın .NET Core'a Entegrasyonu
Swagger, API'larınızı kolayca belgelendirmenize ve test etmenize olanak tanıyan bir araçtır. Bu nedenle .NET Core ve Swagger'ı birleştirerek, kolayca test edilebilir ve belgelendirilebilir API'lar oluşturabilirsiniz.
Swagger'ı .NET Core'a entegre edebilmek için öncelikle NuGet paketlerini yüklemeniz gerekmektedir. Swagger'ı yüklemek için aşağıdaki adımları izleyebilirsiniz:
- Visual Studio'da projenizi açın
- Projeye sağ tıklayın ve 'Manage NuGet Packages' seçeneğini seçin
- Arama kutusuna 'Swashbuckle.AspNetCore' yazın ve yükleyin
- Swashbuckle.AspNetCore paketini yüklendikten sonra, Startup.cs dosyasını açın
- ConfigureServices methodu içindeki ConfigureServices fonksiyonuna Swashbuckle'ın kullanımını ekleyin:
services.AddSwaggerGen(c =>{ c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });});
Bu aşamada Swagger'ı kurmuş oldunuz ve .NET Core API'nizi belgelendirebilirsiniz. Ancak, Swagger UI'nin projenize eklenmesi için birkaç adım daha yapmanız gerekiyor.
Swagger UI, Swagger belgelerinizi görsel olarak temsil eder ve doğrudan .NET Core API projesinde kullanılabilirdir. Swagger UI'nin kurulumu için aşağıdaki adımları takip edebilirsiniz:
- Startup.cs dosyasını açın
- Configure methodu içindeki app.UseSwagger(); ve app.UseSwaggerUI(c => ...); fonksiyonlarını ekleyin:
app.UseSwagger();app.UseSwaggerUI(c =>{ c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");});
Bu aşamaya kadar, Swagger UI projenize eklenmiştir ve .NET Core API'nizi test etmek için kullanılabilir hale gelmiştir. Swagger UI özelliklerini kullanarak API'de gezinerek, kullanıcıların API'yı nasıl kullanacaklarına dair fikir edinebilirsiniz.
Sonuç olarak, .NET Core ve Swagger'ın uyumlu kullanımı ciddi zaman tasarrufu sağlayabilir ve daha kolay anlaşılabilir bir API sunar. Bu adımları izleyerek, .NET Core'a Swagger'ın nasıl entegre edileceğini öğrendiniz ve yapmanız gereken konfigürasyonları gerçekleştirdiniz.