Преобразуйте классы C# в JSON!

Вставьте код C# (class·record) и получите пример JSON! Поддержка: System.Text.Json [JsonPropertyName], Newtonsoft.Json [JsonProperty]. Удобно для документации API и тестовых тел запросов (mock request body).
C#
Результат
 

Преобразуйте классы C# в JSON!

Вставьте модели C#, написанные через class, record или struct, и получите пример JSON-документа по правилам System.Text.Json и Newtonsoft.Json. Можно выбрать политику имён camelCase, которую ASP.NET Core использует по умолчанию, или имена свойств как написаны; имена, заданные через [JsonPropertyName] или [JsonProperty], всегда имеют приоритет.

Пригодится, чтобы передать фронтенду или внешнему партнёру пример по моделям запросов/ответов Web API, заполнить примеры Swagger (Swashbuckle) или подготовить тела запросов для интеграционных тестов с HttpClient.

Как пользоваться

  1. Вставьте исходный код модели. using, namespace, конструкторы и методы можно не удалять.
  2. Выберите Политика имён: camelCase (по умолчанию в ASP.NET Core) для стандартных проектов Web API или Имена свойств как есть, если вы задаёте PropertyNamingPolicy = null или полагаетесь на настройки Newtonsoft по умолчанию.
  3. Когда Корневой тип стоит в Автоматически, корнем становится первый тип, на который не ссылается ни одна другая модель; при необходимости выберите другой из списка.
  4. Скопируйте JSON в пример Swagger, файл .http или тело запроса в xUnit. Выбранные опции сохраняются в URL.

Пример

Вход (C#)
public class InventoryItem
{
    public Guid Id { get; set; }
    public string SKU { get; set; } = "";
    [JsonPropertyName("stock_qty")]
    public int StockQuantity { get; set; }
    public StockState State { get; set; } = StockState.InStock;
    public DateTimeOffset UpdatedAt { get; set; }
    public List<string> Barcodes { get; set; } = new();
    [JsonIgnore]
    public string WarehouseNote { get; set; } = "";
    private int _version;
}

public enum StockState { InStock, LowStock, OutOfStock }
Результат (JSON · camelCase)
{
  "id": "00000000-0000-0000-0000-000000000000",
  "sku": "",
  "stock_qty": 0,
  "state": 0,
  "updatedAt": "1970-01-01T00:00:00+00:00",
  "barcodes": [
    ""
  ]
}

При политике camelCase имя целиком заглавными, как SKU, превращается в sku — так же, как в JsonNamingPolicy.CamelCase из System.Text.Json, а [JsonPropertyName("stock_qty")] сохраняет своё имя независимо от политики. WarehouseNote ([JsonIgnore]) и private-поле _version не выводятся. У enum State нет строкового конвертера, поэтому показан 0 — числовое значение его инициализатора StockState.InStock.

Возможности

  • Атрибуты переименования: [JsonPropertyName] из System.Text.Json, [JsonProperty] из Newtonsoft и [DataMember(Name = ...)].
  • Включаются только public свойства и поля, а также непубличные члены с [JsonInclude]. static, const, [JsonIgnore] и [IgnoreDataMember] исключаются; условные игноры вроде Condition = WhenWritingNull сохраняются.
  • Поддерживаются позиционные records (record Customer(long Id, string Name)) и цели [property: JsonPropertyName(...)].
  • Вычисляемые свойства с телом-выражением (=> ...) включаются, как их сериализовал бы System.Text.Json.
  • Enum записываются числами, как по умолчанию делают System.Text.Json и Newtonsoft (включая явные значения вроде = 10). С [JsonConverter(typeof(JsonStringEnumConverter))] (или StringEnumConverter из Newtonsoft) на enum или свойстве, либо с [JsonStringEnumMemberName] / [EnumMember(Value = ...)] на членах вместо этого используется строка с именем.
  • Даты и ID: DateTime → 1970-01-01T00:00:00, DateTimeOffset → 1970-01-01T00:00:00+00:00, DateOnly → 1970-01-01, TimeOnly/TimeSpan → 00:00:00, Guid → GUID из одних нулей.
  • int?/Nullable<T> используют внутренний тип, List<T>/IEnumerable<T>/массивы получают один элемент, Dictionary<int, V> использует ключ "0", а object, JsonElement и JObject становятся null.
  • Литеральные инициализаторы (= 1.5, = "KRW") используются как значения примера.

Сценарии использования

Примеры Swashbuckle, совпадающие с реальными ответами

В DTO, где [JsonPropertyName] смешан с именованием по умолчанию, сгенерированные Swagger UI примеры легко понять неправильно. Используйте этот вывод в ISchemaFilter или XML-комментарии <example>, чтобы у документации и ответа были одинаковые ключи.

Переход с Newtonsoft на System.Text.Json

Переключайте Политика имён туда и обратно на одной и той же модели, чтобы заранее увидеть, как изменится регистр ключей после миграции.

Проверка контракта между клиентом на Unity/MAUI и сервером

Когда клиент и сервер хранят отдельные копии модели, сгенерируйте JSON с каждой стороны и сравните — так расхождения в именах ключей быстро найдутся.

Примечания и ограничения

  • JsonStringEnumConverter, зарегистрированный глобально через AddJsonOptions в Program.cs, не виден в коде модели, поэтому enum всё равно выводятся числами. Чтобы увидеть имена, перед вставкой добавьте [JsonConverter(typeof(JsonStringEnumConverter))] к объявлению enum.
  • Nullable ссылочные типы вроде string? получают типизированное значение примера, а не null.
  • Пользовательские атрибуты [JsonConverter], кроме строкового конвертера enum, DefaultIgnoreCondition в JsonSerializerOptions и политики snake_case (JsonNamingPolicy.SnakeCaseLower) не применяются.
  • Полиморфизм через [JsonPolymorphic]/[JsonDerivedType] не поддерживается; генерируется только объявленный базовый тип.

Частые вопросы

Когда выбирать каждый вариант Политика имён?

ASP.NET Core Web API использует JsonSerializerDefaults.Web, то есть camelCase. Консольное приложение, вызывающее JsonSerializer.Serialize без опций, или Newtonsoft.Json с настройками по умолчанию сохраняют имена свойств — там выбирайте Имена свойств как есть.

Почему появляется вычисляемое свойство вроде public string FullName => ...?

И System.Text.Json, и Newtonsoft.Json сериализуют публичные свойства с геттером, так что вычисляемые свойства тоже попадают в ответы. Добавьте [JsonIgnore], если не хотите их выводить.

[JsonPropertyName] на позиционном параметре record не переименовывает ключ во время выполнения.

Без указания цели компилятор применяет атрибут только к параметру конструктора. Этот инструмент распознаёт обе формы, но чтобы надёжно переименовать сериализуемое свойство, пишите [property: JsonPropertyName("...")].

Почему у значений DateTime нет Z?

DateTime с DateTimeKind.Unspecified сериализуется без смещения. Если нужно явное смещение UTC, DateTimeOffset даёт форму с +00:00.