https://github.com/lucasteles/jsonenum
Json Convert helpers for C# Enums
https://github.com/lucasteles/jsonenum
Last synced: 6 months ago
JSON representation
Json Convert helpers for C# Enums
- Host: GitHub
- URL: https://github.com/lucasteles/jsonenum
- Owner: lucasteles
- License: mit
- Created: 2023-07-06T20:29:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T15:14:38.000Z (over 1 year ago)
- Last Synced: 2024-04-29T16:35:31.652Z (over 1 year ago)
- Language: C#
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/lucasteles/JsonEnum/actions/workflows/ci.yml)
[](https://www.nuget.org/packages/JsonEnum)
# JsonEnum
Converters to customize your enum serialization on `System.Text.Json`
## Getting started
[NuGet package](https://www.nuget.org/packages/JsonEnum) available:
```ps
$ dotnet add package JsonEnum
```
## Enum Converters
This library defines the following converters:
- `JsonEnumStringConverter`: Covert to enum case name as string
- `JsonEnumDescriptionConverter`: Convert to description attribute string
- `JsonEnumMemberValueConverter`: Convert to member value attribute string
- `JsonEnumNumericStringConverter`: Convert to numeric enum value as string
- `JsonEnumNumericConverter`: Convert to numeric enum value
For each converter there is:
- An named attribute like `[JsonEnum(name)Converter]` to set converters on properties or
types
- A generic type `JsonEnum(name)Converter` to be used on specific type for `JsonSerializeOptions.Converters`.
### Using [Description]
Add `JsonEnumDescriptionConverter` to your json options or using the attribute `[JsonEnumDescription]` on
your type.
````csharp
using System.Text.Json;
using System.Text.Json.Serialization;
using System.ComponentModel;
public enum MyEnum
{
[Description("first_value")] Value1,
[Description("second_value")] Value2,
}
public class Foo
{
[JsonEnumDescription]
public MyEnum Value { get; init; }
}
var foo = new Foo { Value = MyEnum.Value1 };
````
`foo` will be serialized to/from:
```json
{
"Value": "first_value"
}
```
### EnumMember [Description]
Add `JsonEnumDescriptionConverter` to your json options or using the attribute `[JsonEnumDescription]` on
your type.
````csharp
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Runtime.Serialization;
public enum MyEnum
{
[EnumMember(Value = "first-value")] Value1,
[EnumMember(Value = "second-value")] Value2,
}
public class Foo
{
[JsonEnumMemberValue]
public MyEnum Value { get; init; }
}
var foo = new Foo { Value = MyEnum.Value1 };
````
`foo` will be serialized to/from:
```json
{
"Value": "first-value"
}
```
### EnumMember [Description]
Add `JsonEnumDescriptionConverter` to your json options or using the attribute `[JsonEnumDescription]` on
your type.
````csharp
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Runtime.Serialization;
public enum MyEnum
{
[EnumMember(Value = "first-value")] Value1,
[EnumMember(Value = "second-value")] Value2,
}
public class Foo
{
[JsonEnumMemberValue]
public MyEnum Value { get; init; }
}
var foo = new Foo { Value = MyEnum.Value1 };
````
`foo` will be serialized to/from:
```json
{
"Value": "first-value"
}
```
### Numeric string
Serialize enum as a string of the **numeric** value of the enum.
````csharp
using System.Text.Json;
using System.Text.Json.Serialization;
public enum MyEnum
{
Value1 = 10,
Value2 = 20,
}
public class Foo
{
[JsonEnumNumericString]
public MyEnum Value { get; init; }
}
var foo = new Foo { Value = MyEnum.Value1 };
````
`foo` will be serialized to/from:
```json
{
"Value": "10"
}
```
### Numeric
This can be useful when you already have set a global converter on `JsonSerializerOptions.Converters` and need to
override
the behavior to numeric.
````csharp
using System.Text.Json;
using System.Text.Json.Serialization;
public enum MyEnum
{
Value1 = 10,
Value2 = 20,
}
public class Foo
{
[JsonEnumNumeric]
public MyEnum Value { get; init; }
}
var foo = new Foo { Value = MyEnum.Value1 };
JsonSerializer.Serialize(foo, new JsonSerializerOptions()
{
Converters = { new JsonEnumStringConverter() }, // will be ignored on Foo type
});
````
`foo` will be serialized to/from:
```json
{
"Value": 10
}
```
## Swagger
If you are using `Swashbuckle.AspNetCore` you will notice that those attributes and converters are not respected by
the `swagger` schema. You can use [**this nuget package**](https://www.nuget.org/packages/JsonEnum.Swagger) to fix it:
```ps
$ dotnet add package JsonEnum.Swagger
```
And use the `JsonEnumSchemaFilter` on your swagger configuration:
```csharp
services.AddSwaggerGen(options =>
{
options.SchemaFilter();
});
```