ApiSDK 1.0.15

ApiSDK NuGet Paketi

ApiSDK, modern .NET uygulamaları için hızlı ve güvenli API geliştirme süreçlerini kolaylaştırmak amacıyla tasarlanmış kapsamlı bir NuGet paketidir. Bu SDK, kimlik doğrulama, veri doğrulama, API versiyonlama, dokümantasyon ve performans izleme gibi birçok yaygın API gereksinimini tek bir çatı altında toplar.

Özellikler

• JWT Kimlik Doğrulama: Güvenli ve ölçeklenebilir token tabanlı kimlik doğrulama mekanizması.
• FluentValidation Entegrasyonu: Güçlü ve esnek veri doğrulama kuralları ile isteklerinizi kolayca doğrulayın.
• API Versiyonlama: API'lerinizin farklı sürümlerini kolayca yönetin ve dağıtın.
• Swagger/OpenAPI Desteği: API'lerinizin otomatik dokümantasyonunu sağlayın ve geliştiricilerin API'lerinizi keşfetmesini kolaylaştırın.
• Sağlık Kontrolleri (Health Checks): Uygulamanızın ve bağımlılıklarının sağlık durumunu izleyin.
• Özel CORS Yapılandırması: Çapraz kaynak isteklerini güvenli bir şekilde yönetin.
• Yanıt Önbellekleme: API yanıtlarını önbelleğe alarak performansı artırın.
• Ocelot Entegrasyonu (İsteğe Bağlı): API Gateway çözümleri ile entegrasyon için kolaylaştırılmış destek.
• Merkezi Hata Yönetimi: API genelinde tutarlı hata yanıtları sağlayın.

Kurulum

ApiSDK'yı projenize NuGet üzerinden ekleyebilirsiniz:

dotnet add package ApiSDK

veya ApiSDK.csproj dosyanıza aşağıdaki satırı ekleyin:

<PackageReference Include="ApiSDK" Version="1.0.5" />

Kullanım

ApiSDK'yı uygulamanıza entegre etmek için Program.cs dosyanızda aşağıdaki adımları izleyin:

Servislerin Eklenmesi

builder.Services koleksiyonuna AddApiCoreServices metodunu kullanarak ApiSDK'nın temel servislerini ekleyin:

using ApiSDK;
using System.Reflection;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApiCoreServices(Assembly.GetExecutingAssembly());

// Diğer servislerinizi buraya ekleyin
// builder.Services.AddControllers();

var app = builder.Build();

Assembly.GetExecutingAssembly() parametresi, FluentValidation için doğrulayıcıların bulunduğu derlemeyi belirtir.

Middleware'lerin Yapılandırılması

app nesnesi üzerinde UseApiCoreServices metodunu çağırarak ApiSDK'nın middleware'lerini yapılandırın:

// ... existing code ...

app.UseApiCoreServices();

// Diğer middleware'lerinizi buraya ekleyin
// app.MapControllers();

app.Run();

Yapılandırma

ApiSDK, bazı özellikler için yapılandırma seçenekleri sunar. Bu yapılandırmalar genellikle appsettings.json dosyası veya doğrudan kod içinde yapılabilir.

JWT Ayarları

JWT kimlik doğrulama için gerekli ayarlar JwtConfigurations.cs içinde tanımlanmıştır. appsettings.json dosyanızda aşağıdaki gibi bir bölüm oluşturarak JWT ayarlarınızı yapılandırabilirsiniz:

"Jwt": {
    "Issuer": "your-issuer",
    "Audience": "your-audience",
    "Key": "your-secret-key", // Güvenli bir anahtar kullanın
    "AccessTokenExpiration": 60, // Dakika
    "RefreshTokenExpiration": 120 // Dakika
}

Swagger Ayarları

Swagger/OpenAPI dokümantasyonu için başlık ve versiyon gibi ayarları SwaggerConfigurations.cs içinde özelleştirebilirsiniz.

// appsettings.json dosyasında ilgili bir bölüm oluşturulabilir veya kod içinde ayarlanabilir.

Özel Başlık (Header) Ayarları

Uygulamanıza özel başlıklar eklemek için HeaderConfigurations.cs dosyasını ve ApplicationHeaderMiddleware'i kullanabilirsiniz.

// appsettings.json dosyasında ilgili bir bölüm oluşturulabilir veya kod içinde ayarlanabilir.

Katkıda Bulunma

Projeye katkıda bulunmaktan çekinmeyin. Hata raporları, özellik istekleri veya kod katkıları her zaman memnuniyetle karşılanır.

Lisans

Bu proje MIT Lisansı altında lisanslanmıştır. Daha fazla bilgi için LICENSE dosyasına bakın (eğer varsa).