Вставьте модели C#, написанные через class, record или struct, и получите пример JSON-документа по правилам System.Text.Json и Newtonsoft.Json. Можно выбрать политику имён camelCase, которую ASP.NET Core использует по умолчанию, или имена свойств как написаны; имена, заданные через [JsonPropertyName] или [JsonProperty], всегда имеют приоритет.
Пригодится, чтобы передать фронтенду или внешнему партнёру пример по моделям запросов/ответов Web API, заполнить примеры Swagger (Swashbuckle) или подготовить тела запросов для интеграционных тестов с HttpClient.
using, namespace, конструкторы и методы можно не удалять.Политика имён: camelCase (по умолчанию в ASP.NET Core) для стандартных проектов Web API или Имена свойств как есть, если вы задаёте PropertyNamingPolicy = null или полагаетесь на настройки Newtonsoft по умолчанию.Корневой тип стоит в Автоматически, корнем становится первый тип, на который не ссылается ни одна другая модель; при необходимости выберите другой из списка..http или тело запроса в xUnit. Выбранные опции сохраняются в URL.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 }{
"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 сохраняются.record Customer(long Id, string Name)) и цели [property: JsonPropertyName(...)].=> ...) включаются, как их сериализовал бы System.Text.Json.= 10). С [JsonConverter(typeof(JsonStringEnumConverter))] (или StringEnumConverter из Newtonsoft) на enum или свойстве, либо с [JsonStringEnumMemberName] / [EnumMember(Value = ...)] на членах вместо этого используется строка с именем.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") используются как значения примера.В DTO, где [JsonPropertyName] смешан с именованием по умолчанию, сгенерированные Swagger UI примеры легко понять неправильно. Используйте этот вывод в ISchemaFilter или XML-комментарии <example>, чтобы у документации и ответа были одинаковые ключи.
Переключайте Политика имён туда и обратно на одной и той же модели, чтобы заранее увидеть, как изменится регистр ключей после миграции.
Когда клиент и сервер хранят отдельные копии модели, сгенерируйте JSON с каждой стороны и сравните — так расхождения в именах ключей быстро найдутся.
JsonStringEnumConverter, зарегистрированный глобально через AddJsonOptions в Program.cs, не виден в коде модели, поэтому enum всё равно выводятся числами. Чтобы увидеть имена, перед вставкой добавьте [JsonConverter(typeof(JsonStringEnumConverter))] к объявлению enum.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.