Collez des modèles C# construits avec class, record ou struct et obtenez un document JSON d'exemple qui suit les règles de System.Text.Json et Newtonsoft.Json. Choisissez entre la politique de nommage camelCase qu'ASP.NET Core applique par défaut et les noms de propriétés tels qu'écrits ; les noms définis via [JsonPropertyName] ou [JsonProperty] l'emportent toujours.
Utilisez-le pour fournir un exemple à un frontend ou à un partenaire externe à partir des modèles de requête/réponse d'une Web API, pour remplir les exemples Swagger (Swashbuckle) ou pour préparer des corps de requête pour des tests d'intégration avec HttpClient.
using, namespace, constructeurs et méthodes peuvent rester.Politique de nommage : camelCase (par défaut dans ASP.NET Core) pour un projet Web API standard, ou Noms de propriété tels quels si vous avez défini PropertyNamingPolicy = null ou utilisez les réglages par défaut de Newtonsoft.Type racine sur Automatique, le premier type qu'aucun autre modèle ne référence devient la racine ; changez-le dans la liste si besoin..http ou un corps de requête xUnit. Vos choix d'options sont enregistrés dans l'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": [
""
]
}Avec la politique camelCase, un nom tout en capitales comme SKU devient sku, conformément à JsonNamingPolicy.CamelCase de System.Text.Json, tandis que [JsonPropertyName("stock_qty")] garde son nom quelle que soit la politique. WarehouseNote ([JsonIgnore]) et le champ private _version sont omis. L'enum State n'a pas de convertisseur en chaîne : il affiche donc 0, la valeur numérique de son initialiseur StockState.InStock.
[JsonPropertyName] de System.Text.Json, [JsonProperty] de Newtonsoft et [DataMember(Name = ...)].public sont inclus, ainsi que les membres non publics marqués [JsonInclude]. static, const, [JsonIgnore] et [IgnoreDataMember] sont exclus ; les exclusions conditionnelles comme Condition = WhenWritingNull sont conservées.record Customer(long Id, string Name)) et les cibles [property: JsonPropertyName(...)] sont pris en charge.=> ...) sont incluses, comme System.Text.Json les sérialiserait.= 10 comprises). Avec [JsonConverter(typeof(JsonStringEnumConverter))] (ou StringEnumConverter de Newtonsoft) sur l'enum ou la propriété, ou [JsonStringEnumMemberName] / [EnumMember(Value = ...)] sur les membres, c'est le nom sous forme de chaîne qui est utilisé.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 entièrement à zéro.int?/Nullable<T> utilisent le type interne, List<T>/IEnumerable<T>/tableaux reçoivent un élément, Dictionary<int, V> utilise une clé "0", et object, JsonElement et JObject deviennent null.= 1.5, = "KRW") servent de valeurs d'exemple.Des DTO qui mélangent [JsonPropertyName] et le nommage par défaut rendent les exemples générés par Swagger UI faciles à mal interpréter. Utilisez cette sortie dans un ISchemaFilter ou un commentaire XML <example> pour que la doc et la réponse partagent les mêmes clés.
Basculez la Politique de nommage dans un sens puis dans l'autre sur le même modèle pour prévisualiser comment la casse des clés change après la migration.
Quand client et serveur ont chacun leur copie d'un modèle, générez le JSON des deux côtés et comparez-les pour repérer rapidement les écarts de noms de clés.
JsonStringEnumConverter enregistré globalement via AddJsonOptions dans Program.cs n'est pas visible dans le code du modèle : les enums sortent donc toujours en nombres. Pour voir les noms, ajoutez [JsonConverter(typeof(JsonStringEnumConverter))] à la déclaration de l'enum avant de coller.string? reçoivent un exemple typé, pas null.[JsonConverter] personnalisés autres que le convertisseur d'enum en chaîne, DefaultIgnoreCondition dans JsonSerializerOptions et les politiques snake_case (JsonNamingPolicy.SnakeCaseLower) ne sont pas appliqués.[JsonPolymorphic]/[JsonDerivedType] n'est pas pris en charge ; seul le type de base déclaré est généré.Politique de nommage ?ASP.NET Core Web API utilise JsonSerializerDefaults.Web, qui est en camelCase. Une application console appelant JsonSerializer.Serialize sans options, ou Newtonsoft.Json avec ses réglages par défaut, conserve les noms de propriétés : choisissez alors Noms de propriété tels quels.
public string FullName => ... apparaît-elle ?System.Text.Json comme Newtonsoft.Json sérialisent les propriétés publiques dotées d'un getter : les propriétés calculées se retrouvent donc aussi dans les réponses. Ajoutez [JsonIgnore] si vous ne voulez pas les exporter.
[JsonPropertyName] sur un paramètre positionnel de record ne renomme pas la clé à l'exécution.Sans cible, le compilateur n'applique l'attribut qu'au paramètre du constructeur. Cet outil reconnaît les deux formes, mais pour renommer de façon fiable la propriété sérialisée, écrivez [property: JsonPropertyName("...")].
Z sur les valeurs DateTime ?Un DateTime de DateTimeKind.Unspecified est sérialisé sans décalage. S'il vous faut un décalage UTC explicite, DateTimeOffset produit la forme +00:00.