Описание Swashbuckle не отображается для свойств с определяемыми пользователем типами - PullRequest
Новая
       153

Описание Swashbuckle не отображается для свойств с определяемыми пользователем типами

0 голосов
/ 06 августа 2020

Swashbuckle не подбирает описание при генерации Swagger Json для свойств с типами классов. Он отлично работает с примитивными типами данных.

, например, в приведенном ниже коде, оба определения отображаются в файле xml, но только поле с типом string отображается с описанием в Swagger Json. Поле типа ServiceData отсутствует Описание. Это поведение одинаково для всего проекта: 

{
    using Newtonsoft.Json;
    using Newtonsoft.Json.Converters;

    /// <summary>
    ///     Service Creation Request.
    /// </summary>
    public class ServiceCreationRequest
    {
        public ServiceCreationRequest(Servicedata serviceData, string name)
        {
            this.ServiceData = serviceData;
            this.Name = name;
        }

        /// <summary>
        ///     Gets Service Data.
        /// </summary>
        public ServiceData ServiceData { get; set; }

        /// <summary>
        ///     User Defined Service Name
        /// </summary>
        public string ServiceName{ get; set;}
    }
}

фрагмент из xml файла: 

<member name="P:Service.ServiceCreationRequest.ServiceData ">
    <summary>
        Gets Service Data.
    </summary>
</member>

<member name="P:Service.ServiceCreationRequest.Name">
    <summary>
       User Defined Service Name
    </summary>
</member>

swagger json фрагмент: 

"ServiceCreationRequest": {
    "type": "object",
    "properties": {
      "serviceData": {
        "$ref": "#/components/schemas/"
      },
      "name": {
        "type": "string",
        "description": "User Defined Service Name.",
        "nullable": true,
        "readOnly": true
      },
    "additionalProperties": false,
    "description": "Service Creation Request."
}

Уведомление description отсутствует для serviceData

...