Gereksinimler: Scalar oldukça güçlüdür ve API dokümantasyonundan farklı dillerde otomatik olarak HTTP çağrı kodu oluşturabilir; API dokümantasyonunu Swagger yerine Scalar kullanarak gösterir.
.NET 9 çıkışından sonra ASP.NET resmi Core ekibi, ASP.NET Core API için Swagger aracı sağlayan Swashbuckle.AspNetCore'un ASP.NET Core Web API şablonundan kaldırılacağını duyurdu. Bu da gelecekte Web API projeleri oluşturduğumuzda, Swagger API dokümantasyonunun otomatik olarak üretilmeyeceği anlamına geliyor. Bugün, EasySQLite .NET 9 projemizde etkileşimli API dokümantasyonu için Scalar'ı deneyelim.
Bağlantı:Bağlantı girişi görünür.
Swagger'ın görevden alınmasının nedenleri şu şekilde özetlenebilir:
- Swashbuckle Kötü Bakım: Swashbuckle projesi artık topluluk sahipleri tarafından aktif olarak sürdürülmemektedir, birçok sorun çözülmemiş ve .NET 8 ile uyumlu resmi bir sürüm yayımlanmamıştır.
- Microsoft.AspNetCore.OpenApi'ye dönelim: ASP.NET Core ekibi, Microsoft.AspNetCore.OpenApi'nin Swashbuckle'ın yerini alacak ve OpenAPI dokümantasyon oluşturma kapasitesini güçlendirecek.
- Mevcut alternatifler: Swashbuckle dışında, NSwag gibi diğer projeler OpenAPI dokümantasyon üretimi ve istemci/sunucu kodu üretimini destekler; böylece geliştiriciler proje ihtiyaçlarına göre uygun çözümü seçebilirler.
- Geliştirilmiş yerleşik API desteği: Core 3.1 ASP.NET den itibaren çerçeve, ApiExplorer gibi meta veri desteği sağlamıştır. Visual Studio ve Visual Studio Code'un .http dosyalarına dahili desteğiyle birleşince, API testi ve hata ayıklama deneyimi daha da iyidir.
- OpenAPI'yi temel bileşen olarak tanıtmak: ASP.NET Core ekibi, .NET 9'da OpenAPI entegrasyonunu daha da geliştirmeyi ve JSON formatlı OpenAPI dokümantasyonu oluşturmaya odaklanan temel bir bileşen haline getirmeyi planlıyor.
Skaler
Scalar, her boyuttaki API projeleri için uygun, güçlü ve kullanımı kolay bir API istemcisi ve dokümantasyon oluşturma aracıdır ve birden fazla programlama dili ile platformu destekler.
Açık Kaynak Adresi:Bağlantı girişi görünür.
ASP.NET Core Skalar entegre eder
Entegre dokümantasyon:Bağlantı girişi görünür.
Aşağıdaki şekilde referans verilen bir ASP.NET Core 9 projesi oluşturun:
Program.cs'de servis ve skaler ara yazılım ekleyin, kod aşağıdaki gibidir:
Kontrol WeatherForecastController.cs düzenleme, aşağıdaki gibi kodla:
Projeyi başlatın, tarayıcınızı açın ve şu adresleri ziyaret edin:http://localhost:5088/api-docs, aşağıdaki şekilde gösterildiği gibi:
Farklı dillerde HTTP kütüphaneleri için özel çağrı kodu oluşturmayı seçebilirsiniz. C# HttpClient kütüphanesini örnek alarak, oluşturulan kod şu şekildedir:
Ayrıca çevrimiçi arayüz testini destekler. Test Talebi butonuna tıklayın, gönderi verilerini doldurun, ardından gönder tuşuna tıklayın ve talebi gönderin, aşağıda gösterildiği gibi:
Varsayılan HTTP istemcisini özelleştirin. C# ekipleri için, C# HttpClient çağrı kodunu otomatik olarak gösteren API dokümantasyon arayüzünü açmak istiyoruz. Her ilk kez manuel seçmek istemiyorsanız, aşağıdaki şekilde yapılandırın:
Ask AI özelliğini silin ve Ask AI Agent butonunu kaldırın. Bu özellik biraz gereksiz geliyor. Kod şöyle:
Aşağıda gösterildiği gibi:
Silindikten sonra, aşağıda gösterildiği gibi:
Benzer şekilde, MCP işlevselliğini devre dışı bırakın, aşağıdaki gibi kodlayın:
Tam yapılandırma şu şekildedir:
JWT doğrulama ekleyin ve istek başlığını taşıyınTaşıyıcı Jeton
Tüm OpenAPI dokümantasyonuna güvenlik gereksinimleri ekleyin, aşağıdaki şekilde kodlayın:
Aşağıda gösterildiği gibi:
OpenID Connect (OIDC):Bağlantı girişi görünür.
Referans:
Bağlantı girişi görünür.
Bağlantı girişi görünür. |
Yayınlandı5 dakika önce
|
|
|
|
Ev sahibi|
Yayınlandı1 dakika önce
|
