{"id":25907949,"url":"https://github.com/webbeta/nserializer","last_synced_at":"2026-05-10T01:05:32.505Z","repository":{"id":40884415,"uuid":"252285167","full_name":"webbeta/NSerializer","owner":"webbeta","description":".NET Core port of our framework agnostic YAML based Serializer for Java (https://github.com/webbeta/Serializer)","archived":false,"fork":false,"pushed_at":"2022-12-08T10:04:55.000Z","size":59,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-02T09:07:05.647Z","etag":null,"topics":["csharp","net-core","serializer","yml"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webbeta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-01T20:57:20.000Z","updated_at":"2021-01-25T11:13:44.000Z","dependencies_parsed_at":"2023-01-25T00:45:57.314Z","dependency_job_id":null,"html_url":"https://github.com/webbeta/NSerializer","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbeta%2FNSerializer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbeta%2FNSerializer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbeta%2FNSerializer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbeta%2FNSerializer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webbeta","download_url":"https://codeload.github.com/webbeta/NSerializer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241622600,"owners_count":19992504,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","net-core","serializer","yml"],"created_at":"2025-03-03T07:15:49.181Z","updated_at":"2025-12-01T06:06:23.524Z","avatar_url":"https://github.com/webbeta.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webBeta NSerializer\n\n[![Build Status](https://travis-ci.org/webbeta/NSerializer.svg?branch=master)](https://travis-ci.org/webbeta/NSerializer)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c9db06803de94cc6aaea9e2fdcbd494e)](https://www.codacy.com/gh/webbeta/NSerializer?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=webbeta/NSerializer\u0026amp;utm_campaign=Badge_Grade)\n[![GitHub license](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![NuGet](https://buildstats.info/nuget/webBeta.NSerializer)](http://www.nuget.org/packages/webBeta.NSerializer)\n\n* [What is webBeta NSerializer?](#what-is-webbeta-nserializer?)\n* [Quick examples](#quick-examples)\n* [License](#license)\n\n## What is webBeta NSerializer?\n\nYML based serializer for .Net Core. Based on JMS serializer https://jmsyst.com/libs/serializer/master/reference/yml_reference\n\nIt is a fork of our [YML based serializer for Java](https://github.com/webbeta/Serializer).\n\nSteps to create a NSerializer instance.\n\n1. Create a cache provider.\n\n```csharp\npublic class MyCache : ICache\n{\n    public string Get(string key)\n    {\n        return null;\n    }\n\n    public void Set(string key, string content)\n    {\n    }\n\n    public void Remove(string key)\n    {\n    }\n}\n```\n\n2. Create a configuration provider.\n\n```csharp\npublic class MyConfigurationProvider : IConfigurationProvider\n{\n    private readonly Dictionary\u003cstring, object\u003e _conf;\n\n    public MyConfigurationProvider(Dictionary\u003cstring, object\u003e conf)\n    {\n        _conf = conf;\n    }\n\n    public bool GetBoolean(string key, bool defaultValue)\n    {\n        return !_conf.ContainsKey(key) ? defaultValue : bool.Parse(_conf[key].ToString());\n    }\n\n    public string GetString(string key, string defaultValue)\n    {\n        return !_conf.ContainsKey(key) ? defaultValue : _conf[key].ToString();\n    }\n}\n```\n\n3. Create an environment provider.\n\n```csharp\npublic class MyEnvironment : IEnvironment\n{    \n    public bool IsProd()\n    {\n        return true;\n    }\n}\n```\n\n4. Then build the NSerializer.\n\n```csharp\nNSerializer serializer = NSerializerBuilder.Build()\n        .WithCache(cache)\n        .WithConfigurationProvider(configurationProvider)\n        .WithEnvironment(environment)\n        .Get();\n```\n\n5. Optionally, add a logger instance:\n\n```csharp\npublic class MyLogger : ILogger\n{    \n    public Level GetLevel()\n    {\n        return Level.ERROR;\n    }\n\n    public void SetLevel(Level level) \n    {\n    }\n\n    public void Error(string message)\n    {\n    }\n}\n\nserializer.SetLogger(logger);\n```\n\n## Quick examples\n\nClass Foo:\n\n```csharp\nnamespace Foo.Bar\n{\n    public class Foo {\n        \n        private string bar = \"foobar\";\n\n        public string AutoPropertyString { get; set; } = \"Foo Autoproperty!\";\n        \n        public string GetBar() {\n            return bar;\n        }\n        \n        public long GetCalc() {\n            return 2 + 2;\n        }\n        \n    }\n}\n\n```\n\nYml file (named ```Foo.Bar.Foo.yml```):\n\n```yaml\nFoo.Bar.Foo:\n  virtual_properties:\n    GetCalc:\n      serialized_name: calc\n      groups: [barGroup]\n  properties:\n    bar:\n      groups: [fooGroup]\n    AutoPropertyString:\n      groups: [autoGroup]\n\n```\n\nUsage:\n\n```csharp\nserializer.Serialize(fooInstance, \"fooGroup\", \"barGroup\", \"autoGroup\");\n\n// it will return\n// {\"bar\": \"foobar\", \"calc\": 4, \"autoPropertyString\": \"Foo Autoproperty!\"}\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbeta%2Fnserializer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebbeta%2Fnserializer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbeta%2Fnserializer/lists"}