Блог

Я пытаюсь найти способ вернуть объект в моем ответе, сохраняя при этом понятный возвращаемый тип.

Итак, для начала, я знаю, что это работает так, как ожидалось.

 public async Task<HttpResponseMessage> DoMyThing(MyObject myObject)
{
    var result = await _myService.CreateMyThingAsync(myObject);
    return Request.CreateResponse(HttpStatusCode.Created, result);

}
  

Но чего я действительно хочу, так это чтобы этот псевдокод работал … каким-то образом.

 public Task<MyObject> DoMyThing(MyObject myObject)
{
    var result = _myService.CreateMyThingAsync(myObject);
    return Request.CreateResponse<Task<MyObject>>(HttpStatusCode.Created, result);
    // or better yet
    return Request.CreateResponse<MyObject>(HttpStatusCode.Created, result);
}
  

Есть ли какая-либо магия в фреймворке, которая заставит это произойти? Или есть какие-либо сторонние библиотеки, которые могут это сделать?

По сути, мне нужно вернуть Task<MyObject> вместо Task<HttpResponseMessage>

Я также открыт для других предложений о том, как вернуть ответ, отличный от 200, при этом возвращая Task<MyObject>

Проблема с указанием типа в качестве возвращаемого типа заключается в том, что вы ограничиваете себя необходимостью возвращать этот тип. Это может показаться странным, но на самом деле будет много случаев, когда вам нужно будет поддерживать множественный ответ, такой как 404, 200 201 и так далее.

Для обработки документации по этому вопросу вы можете использовать атрибут responseType, например:

 [ResponseType(typeof(BookDto))]
        public async Task<IHttpActionResult> GetBook(int id)
        {
            BookDto book = await db.Books.Include(b => b.Author)
                .Where(b => b.BookId == id)
                .Select(AsBookDto)
                .FirstOrDefaultAsync();
            if (book == null)
            {
                return NotFound();
            }

            return Ok(book);
        }
  

Взгляните сюда

Редактировать:

В Asp.Net В основном вы используете атрибут ProducesResponseType, который может использоваться несколько раз для каждого метода

Смотрите здесь

Пример

 [ProducesResponseType(typeof(BookDto), 200)]
[ProducesResponseType(typeof(object), 201)]
         public async Task<IActionResult> GetBook(int id)
            {
                BookDto book = await db.Books.Include(b => b.Author)
                    .Where(b => b.BookId == id)
                    .Select(AsBookDto)
                    .FirstOrDefaultAsync();
                if (book == null)
                {
                    return NotFound();
                }

                return Ok(book);
            }
  

РЕДАКТИРОВАТЬ: Несколько атрибутов ответа до dot net core

Вы можете использовать Swagger для документирования / описания вашего API, у них есть пользовательский атрибут, называемый SwaggerResponse

Портом Swagger для .Net является Swashbuckle, взгляните сюда

Это было бы лучшим шаблоном в WebAPI.

     public async Task<IHttpActionResult> DoMyThing(MyObject myObject)
    {
        try
        {                           
            var result = await _myService.CreateMyThingAsync(myObject);

            return new JsonStreamHttpActionResult<MyObject>(Request, System.Net.HttpStatusCode.Created, result);
        }
        catch (Exception ex)
        {
            Logger.Instance.Error(ex);
            return new HttpActionResult(HttpStatusCode.InternalServerError, "An error has occured");
        }
    }
  

с помощью универсального сериализатора. Затем вы можете использовать «лучший» IHttpActionResult вместо реального возвращаемого значения.

 public class JsonStreamHttpActionResult<T> : IHttpActionResult
{
    private T responseData;
    private HttpRequestMessage request;
    private HttpStatusCode statusCode;

    public JsonStreamHttpActionResult(HttpRequestMessage request, System.Net.HttpStatusCode code, T responseData)
    {
        this.responseData = responseData;
        this.request = request;
        this.statusCode = code;
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        HttpResponseMessage response = request.CreateResponse(statusCode);

        response.Content =
                new PushStreamContent((stream, content, context) =>
                {
                    var serializer = new Newtonsoft.Json.JsonSerializer();
                    using (var writer = new System.IO.StreamWriter(stream))
                    {
                        serializer.Serialize(writer, responseData);
                        stream.Flush();
                    }
                });

        return Task.FromResult(response);
    }
}