在使用JSON.net生成JSON模式时向属性添加描述

Question

是否可以为属性添加描述属性？

我正在使用json.net生成模式：

var shema = new Newtonsoft.Json.Schema.JsonSchemaGenerator();
var sh = shema.Generate(typeof(APIDocumentation.AlertDTO), false).ToString();

我想添加一些简单的文档，让用户了解每个字段的含义。现在我可以使用[JsonObject（description="my-description"）]将描述属性添加到类中，但它不能与类内的属性一起使用。有没有可能做这样的事情：

[JsonObject(Description = "My description")]
public class AlertDTO
{
    [SomeAttribute(Description="Property description")]
    public string Type { get; set; }
}

或者有一种方法可以采用VS风格的注释，并将它们添加到JSON模式中作为描述？

Answer 1

您可以使用System.ComponentModel命名空间中的Description属性。

我花了一段时间才找到，但文档中有一个示例：https://www.newtonsoft.com/jsonschema/help/html/GenerateWithDescriptions.htm