Как сгенерировать параметры тела / пример запроса для страницы справки Web API, имея доступ к необработанному телу запроса - PullRequest
Новая
       56

Как сгенерировать параметры тела / пример запроса для страницы справки Web API, имея доступ к необработанному телу запроса

0 голосов
/ 11 января 2020

Мне нужна помощь при заполнении параметров тела для документации этой конечной точки. Оно выглядит пустым:

Web API Help Page

Я понимаю, что причина этого заключается в том, что я в настоящее время читаю тело запроса и затем преобразую информацию в PackageUpdate. Так как я читаю необработанное тело запроса таким образом, у задачи нет параметров, поэтому страница справки не будет указывать их.

Sample Request:

{
  "PackageId": "package/3e585e1c-d6cd-4b6c-aa1c-aa674d11c944",
  "SoldDateTime": "2018-08-13 19:57:54.000",
  "GuaranteeTermExpiresDate": null
}

PackageUpdate class:

    [DataContract]
    public class PackageUpdate: BaseRequest
    {
        /// <summary>
        ///     Get or Set the package ID of the package to update
        /// </summary>
        [Required]
        [DataMember]
        public string PackageId { get; set; }

        /// <summary>
        ///     Get or Set the Sold Date Time field of the package
        /// </summary>
        [DataMember]
        public DateTime? SoldDateTime { get; set; }

        /// <summary>
        ///     Get or Set the Guarantee Term Expires Date field of the package
        /// </summary>
        [DataMember]
        public DateTime? GuaranteeTermExpiresDate { get; set; }

        /// <summary>
        ///     Get or Set the Premium Promised On field of the package
        /// </summary>
        [DataMember]
        public DateTime? PremiumPromisedOn { get; set; }
    }

UpdatePackageAsync Method:

        /// <summary>
        ///     Updates a package.
        /// </summary>
        [Route("update"), Description("Patch a specific package")]
        [HttpPatch]
        [ResponseType(typeof(Package))]
        public async Task<IHttpActionResult> UpdatePackageAsync()
        {
            string requestBody = await Request.Content.ReadAsStringAsync();
            PackageUpdate request = new PackageUpdate();

            try
            {
                JsonSerializerSettings settings = new JsonSerializerSettings{ MissingMemberHandling = MissingMemberHandling.Error };
                request = JsonConvert.DeserializeObject<PackageUpdate>(requestBody, settings);
            }   
            catch(Exception e)
            {
                return BadRequest("Patch Error -> " + e.Message);
            }

            //Do stuff with request

        }

Как я могу получить поле Body Parameters в документации, отражающее свойства PackageUpdate, и при этом иметь доступ к необработанному телу запроса?

Ранее я пробовал приведенное ниже решение из другого поста, но оно не позволило бы мне получить доступ к телу запроса в виде строки. 

public async Task<IHttpActionResult> UpdatePackageAsync([FromBody] PackageUpdate request)

1 Ответ

0 голосов
/ 14 января 2020

В итоге я попробовал несколько решений, которые нашел на сайте, а затем нашел решение ( здесь ), которое позволяет мне искать начало потока, копировать в новый поток и возвращать тело к моей Задаче.

Решение: 

using (var stream = new MemoryStream())
{
    var context = (HttpContextBase)Request.Properties["MS_HttpContext"];
    context.Request.InputStream.Seek(0, SeekOrigin.Begin);
    context.Request.InputStream.CopyTo(stream);
    string requestBody = Encoding.UTF8.GetString(stream.ToArray());
}

Применимо к моему коду, я использовал его следующим образом: 

public async Task<IHttpActionResult> UpdatePackageAsync(PackageUpdate request)
{
     string requestBody = ReadInputStream();
     // do stuff with request
}

private string ReadInputStream()
{
      using (var stream = new MemoryStream())
      {
           var context = (HttpContextBase)Request.Properties["MS_HttpContext"];
           context.Request.InputStream.Seek(0, SeekOrigin.Begin);
           context.Request.InputStream.CopyTo(stream);
           return Encoding.UTF8.GetString(stream.ToArray());
      }
}
...