[TR] IReturn ve IReturn<T> temel hata/success kontrol altyapısı sağlayan bu paket, uygulama katmanlarınızda tek tip sonuç nesneleri kullanarak kod tekrarını azaltmanızı ve merkezi bir hata/yönetim stratejisi oluşturmanızı amaçlar. Geleneksel metot imzalarından dönen ham veriler veya null kontrolleri yerine, her bir işlem çağrısının sonucu olarak en azından bir IReturn nesnesi döndürülür. Bu sayede: - Kodunuzda “Status” kontrolü, hata mesajı ve istisna bilgisi tek bir objede toplanır. - IReturn<T> sayesinde, veri taşıyan operasyonda hem “Status” hem de “Data” değerlerini birlikte kontrol edebilirsiniz. - NullDataSuccess ve NullDataError gibi ön tanımlı tipler ile filtre sonuçlarında “hata yok ama veri null” veya “hata ile veri null” senaryolarını kolayca yönetebilirsiniz. - Tüm başarı ve hata senaryoları, SuccessReturn ve ErrorReturn sınıfları kullanılarak standartlaştırılmıştır. - Genişleyebilir yapısı sayesinde ilerleyen sürümlerde logging, JSON yapılandırma ve daha ileri seviye hata yönetimi kolayca eklenebilir. - SOLID ve Clean Code prensiplerine uygun, immutable record tipleriyle yazıldığı için thread-safe ve bakımı kolay bir altyapı sunar. Bu paket yalnızca .NET 8 ve üzeri sürümlerle uyumludur. NuGet üzerinden kolayca referans alınarak kullanılabilir. Uygulamanızda ihtiyaç duyduğunuz tüm “başarı/başarısızlık” dönüşlerini tek bir standart içinde toplar, geliştirici deneyimini iyileştirirken hata ayıklamayı da basitleştirir. [EN] This package provides the fundamental error/success handling infrastructure via IReturn and IReturn<T> interfaces, aiming to reduce code repetition and establish a centralized result management strategy across your application layers. Instead of returning raw data or performing null checks directly, every method invocation returns at least an IReturn object. With this approach: - The “Status” check, error message, and exception details are encapsulated in a single object. - IReturn<T> allows you to handle both “Status” and “Data” values together in data-carrying operations. - Predefined types such as NullDataSuccess and NullDataError make it effortless to handle “no error but data is null” or “error with null data” scenarios in filtering operations. - All success and error scenarios are standardized via the SuccessReturn and ErrorReturn classes. - Its extensible design enables easy addition of logging, JSON configuration, and advanced error management in future versions. - Written using immutable record types following SOLID and Clean Code principles, it offers a thread-safe and maintainable infrastructure. This package is compatible only with .NET 8 and later versions. It can be referenced via NuGet to provide a unified standard for all “success/failure” returns in your application, enhancing developer experience and simplifying debugging.
Get Started
$ dotnet add package TahaMucasiroglu.ReturnReadme
TahaMucasiroglu.Return
TR
🌟 Proje Tanıtımı
TahaMucasiroglu.Return, C# dünyasında metot ve servis çağrılarınızın dönüş değerlerini standartlaştırmak için tasarlanmış küçük ve hafif bir kütüphanedir.
IReturn ve IReturn<T> arayüzleri ile hata (error) ve başarı (success) durumlarını tek bir nesnede tutmanızı sağlar.
Ana hedefler:
- Kod tekrarını azaltmak: Her metodun farklı dönüş tipi yerine,
IReturn/IReturn<T>kullanımıyla tek tip sonuç nesnesi döndürmek. - Merkezi hata yönetimi: Hata mesajı, istisna bilgisi ve opsiyonel taşıdığı veri (
Data) tek bir objede toplanır. - SOLID & Clean Code prensiplerine uygun, immutable
recordyapılarıyla thread-safe ve bakımı kolay altyapı sağlamak. - Genişleyebilir yapı: İlerleyen sürümlerde logging, JSON yapılandırma, ilave dönüş tipleri eklemek mümkün.
Özellikler / Features
IReturnarayüzü: Sadece durumu (Status), mesajı (Message) ve istisnayı (Exception) taşır.IReturn<T>arayüzü: Buna ek olarakDataözelliğiyle dönen veriyi de içerir.Return,Return<T>: Temel implemantasyonlar.SuccessReturn,SuccessReturn<T>: Başarılı dönüşler için hazırrecordtipler.ErrorReturn,ErrorReturn<T>: Hata durumlarını temsil eden hazırrecordtipler.NullDataSuccess<T>,NullDataError<T>: “Hata değil ama veri yok” ve “Hata & veri yok” senaryoları için ön tanımlı türler.- Sadece .NET 8 ve sonrası ile uyumlu; ilerleyen sürümlerde multi-target (.NET 6/7/8) desteği eklenecek.
🍽 Kurulum
1. NuGet’den Yükleme
En basit yol, .NET CLI kullanarak:
dotnet add package TahaMucasiroglu.Return
🚀 Kullanım Örneği
Kurulumdan sonra, paketi projenize ekleyip aşağıdaki gibi kısa kullanımlar yapabilirsiniz. Yorum satırlarında önce Türkçe, ardından İngilizce açıklama bulacaksınız.
using Return.Abstract;
using Return.Concrete;
using Return.Models;
class Program
{
static void Main()
{
// [TR] Basit başarılı dönüş: data ve mesaj
// [EN] Simple success return: with data and message
IReturn<string> ok = new SuccessReturn<string>("Merhaba Dünya");
// "Hello World"
Console.WriteLine($"[TR] Başarı? {ok.Status}, Veri: {ok.Data}");
// [EN] Success? True, Data: Hello World
Console.WriteLine();
// [TR] Hata dönüşü: sadece mesaj
// [EN] Error return: message only
IReturn err = new ErrorReturn("Bir hata oluştu!");
// "An error occurred!"
Console.WriteLine($"[TR] Başarı? {err.Status}, Mesaj: {err.Message}");
// [EN] Success? False, Message: An error occurred!
Console.WriteLine();
// [TR] Veri null hatası: hata var, veri yok
// [EN] Null-data error: error and no data
IReturn<string> nullErr = new NullDataError<string>("Veri bulunamadı");
// "No data found"
Console.WriteLine($"[TR] Başarı? {nullErr.Status}, Mesaj: {nullErr.Message}");
// [EN] Success? False, Message: No data found
Console.WriteLine();
// [TR] Veri null ama başarılı: hata yok, veri yok
// [EN] Null-data success: no error but no data
IReturn<string> nullOk = new NullDataSuccess<string>("Veri yok");
// "No data"
Console.WriteLine($"[TR] Başarı? {nullOk.Status}, Mesaj: {nullOk.Message}");
// [EN] Success? True, Message: No data
}
}
🔮 Gelecek Planı
Aşağıda, sonraki sürümlerde eklemeyi planladığımız başlıca özellikler listelenmiştir. Her madde hem Türkçe hem İngilizce açıklama içerir.
-
Logger Desteği / Logger Support
- Uygulama içinde Microsoft.Extensions.Logging veya Serilog gibi bir yapı kullanılarak
loglama altyapısı eklemek. Ayrıca, API tarafındaProgram.csveyaStartup.csüzerinden
kolayca yapılandırılabilir hale getirmek.
- Uygulama içinde Microsoft.Extensions.Logging veya Serilog gibi bir yapı kullanılarak
-
JSON Tabanlı Hata/Yanıt Yapısı / JSON-Based Error/Response Handling
- API projelerinde, exception oluştuğunda ham stack trace yerine JSON formatında
güvenli ve özelleştirilebilir hata nesneleri dönebilmek. Örneğin,
{ "status": false, "message": "...", "errorCode": 123, "details": { ... } }.
- API projelerinde, exception oluştuğunda ham stack trace yerine JSON formatında
-
Multi-Targeting Desteği (net6.0 / net7.0 / net8.0) / Multi-Targeting Support
- Paketimizi yalnızca .NET 8 ile sınırlamamak için .NET 6 ve .NET 7 projelerini de destekleyecek
şekilde<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>kullanmak.
- Paketimizi yalnızca .NET 8 ile sınırlamamak için .NET 6 ve .NET 7 projelerini de destekleyecek
-
Gelişmiş Exception Handling Helpers / Advanced Exception Handling Helpers
- JSON yanıtı içinde hata kodu, izlenebilir ID (trace ID) ve isteği yapan kullanıcının
bağlam bilgileri gibi ek metadataları otomatik ekleyen yardımcı metotlar oluşturmak.
- JSON yanıtı içinde hata kodu, izlenebilir ID (trace ID) ve isteği yapan kullanıcının
-
Swagger/OpenAPI Entegrasyonu / Swagger/OpenAPI Integration
- ASP.NET Core API projelerinde,
IReturn<T>tipi kullanıldığında otomatik olarak
Swagger dökümantasyonunda doğru şema ve örnekler (examples) göstermeyi sağlamak.
- ASP.NET Core API projelerinde,
-
Özel Hata Kodları ve Localization / Custom Error Codes & Localization
- Hata tiplerini, hem Türkçe hem İngilizce hata mesajları ve uluslararası hata
kodları (örneğin1001,2002vb.) ile bir enum veya sabitler koleksiyonu olarak sunmak.
- Hata tiplerini, hem Türkçe hem İngilizce hata mesajları ve uluslararası hata
-
Unit Test ve Kod Kapsamı (Code Coverage) / Unit Testing & Code Coverage
- Paket içindeki temel sınıflar için xUnit veya NUnit kullanarak birim testler hazırlamak,
ayrıca kod kapsamı (code coverage) raporu üretmek.
- Paket içindeki temel sınıflar için xUnit veya NUnit kullanarak birim testler hazırlamak,
-
Dokümantasyon ve Örnek Projeler / Documentation & Sample Projects
- GitHub üzerinde, hem basit Console App hem de ASP.NET Core API örneği içeren birden
fazla örnek proje paylaşmak. Ayrıca, paket işlevlerini anlatan kapsamlı dokümantasyon sayfası
(wiki veya GitHub Pages) oluşturmak.
- GitHub üzerinde, hem basit Console App hem de ASP.NET Core API örneği içeren birden
-
CLI Araçları / CLI Tools
dotnetCLI altındadotnet return initveyadotnet return gengibi komutlarla,
projenize yönelik hazırIReturnşablonları veya konfigürasyon dosyaları oluşturmayı kolaylaştırmak.
Bu özellikler üzerinde çalışarak, paketimizin kullanım kolaylığını, esnekliğini ve genişletilebilirliğini artırmayı hedefliyorum.
EN
🌟 Project Overview
TahaMucasiroglu.Return is a small and lightweight library designed to standardize the return values of your method and service calls in the C# world. With the IReturn and IReturn<T> interfaces, it allows you to encapsulate both error and success states in a single object.
Main goals:
- Reduce code duplication: Instead of having different return types for each method, return a single result object using
IReturn/IReturn<T>. - Centralized error handling: Combine error message, exception information, and optionally carried data (
Data) into one object. - Thread-safe and easy-to-maintain infrastructure with immutable
recordstructures following SOLID & Clean Code principles. - Extensible architecture: Future versions can include logging, JSON configuration, and additional return types.
Features
IReturninterface: Carries onlyStatus,Message, andException.IReturn<T>interface: In addition to the above, includes aDataproperty to hold returned data.Return,Return<T>: Core implementations.SuccessReturn,SuccessReturn<T>: Predefinedrecordtypes for successful returns.ErrorReturn,ErrorReturn<T>: Predefinedrecordtypes for error states.NullDataSuccess<T>,NullDataError<T>: Predefined types for “no error but no data” and “error & no data” scenarios.- Compatible with .NET 8 and above; multi-targeting (.NET 6/7/8) support will be added in upcoming releases.
🍽 Installation
1. Install from NuGet
The simplest way is to use the .NET CLI:
dotnet add package TahaMucasiroglu.Return
🚀 Usage Example After installing the package, add it to your project and use it as shown below. Only English comments are included.
using Return.Abstract;
using Return.Concrete;
using Return.Models;
class Program
{
static void Main()
{
// Simple success return: with data and message
IReturn<string> ok = new SuccessReturn<string>("Hello World");
Console.WriteLine($"Success? {ok.Status}, Data: {ok.Data}");
Console.WriteLine();
// Error return: message only
IReturn err = new ErrorReturn("An error occurred!");
Console.WriteLine($"Success? {err.Status}, Message: {err.Message}");
Console.WriteLine();
// Null-data error: error and no data
IReturn<string> nullErr = new NullDataError<string>("No data found");
Console.WriteLine($"Success? {nullErr.Status}, Message: {nullErr.Message}");
Console.WriteLine();
// Null-data success: no error but no data
IReturn<string> nullOk = new NullDataSuccess<string>("No data");
Console.WriteLine($"Success? {nullOk.Status}, Message: {nullOk.Message}");
}
}
🔮 Roadmap
Aşağıda, sonraki sürümlerde eklemeyi planladığımız başlıca özellikler listelenmiştir. Her madde hem Türkçe hem İngilizce açıklama içerir.
-
Logger Desteği / Logger Support
- Add logging infrastructure using Microsoft.Extensions.Logging or Serilog. Make it
configurable inProgram.csorStartup.csso that developers can enable/disable or
customize log providers easily.
- Add logging infrastructure using Microsoft.Extensions.Logging or Serilog. Make it
-
JSON Tabanlı Hata/Yanıt Yapısı / JSON-Based Error/Response Handling
- In API projects, return a safe/customizable JSON error object instead of raw
stack trace when an exception occurs. For example,
{ "status": false, "message": "...", "errorCode": 123, "details": { ... } }.
- In API projects, return a safe/customizable JSON error object instead of raw
-
Multi-Targeting Desteği (net6.0 / net7.0 / net8.0) / Multi-Targeting Support
- Instead of targeting only .NET 8, enable
<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
so that the package works seamlessly in .NET 6, .NET 7, and .NET 8 projects.
- Instead of targeting only .NET 8, enable
-
Gelişmiş Exception Handling Helpers / Advanced Exception Handling Helpers
- Build helper methods that automatically append additional metadata into JSON responses,
such as error codes, trace IDs, and caller context information.
- Build helper methods that automatically append additional metadata into JSON responses,
-
Swagger/OpenAPI Entegrasyonu / Swagger/OpenAPI Integration
- In ASP.NET Core API projects, ensure that when using
IReturn<T>types, Swagger
documentation correctly shows schemas and examples automatically.
- In ASP.NET Core API projects, ensure that when using
-
Özel Hata Kodları ve Localization / Custom Error Codes & Localization
- Provide error types as an enum or constant set with both Turkish and English messages
and international error codes (e.g.,1001,2002, etc.) for consistent handling across projects.
- Provide error types as an enum or constant set with both Turkish and English messages
-
Unit Test ve Kod Kapsamı (Code Coverage) / Unit Testing & Code Coverage
- Create unit tests for core classes using xUnit or NUnit and generate code coverage reports.
-
Dokümantasyon ve Örnek Projeler / Documentation & Sample Projects
- Provide multiple sample projects on GitHub (a basic Console App and an ASP.NET Core API
example). Also create comprehensive documentation (Wiki or GitHub Pages) explaining package features.
- Provide multiple sample projects on GitHub (a basic Console App and an ASP.NET Core API
-
CLI Araçları / CLI Tools
- Develop CLI commands under
dotnet(e.g.,dotnet return initordotnet return gen)
to scaffoldIReturntemplates or configuration files in a project.
- Develop CLI commands under
By working on these features, we aim to increase the ease of use, flexibility, and extensibility of our package.