Kembalikan konten dengan IHttpActionResult untuk respons yang tidak OK

Untuk kembali dari pengontrol Web API 2, saya dapat mengembalikan konten dengan respons jika responsnya OK (status 200) seperti ini:

    public IHttpActionResult Get()
    {
        string myResult = ...
        return Ok(myResult);
    }

Jika memungkinkan, saya ingin menggunakan tipe hasil bawaan di sini jika memungkinkan: https://msdn.microsoft.com/en-us/library/system.web.http.results(v=vs.118).aspx

Pertanyaan saya adalah, untuk jenis respons lain (bukan 200), bagaimana saya bisa mengembalikan pesan (string) dengannya? Sebagai contoh, saya bisa melakukan ini:

    public IHttpActionResult Get()
    {
       return InternalServerError();
    }

tapi bukan ini:

    public IHttpActionResult Get()
    {
       return InternalServerError("Message describing the error here");
    }

Idealnya saya ingin ini digeneralisasi sehingga saya dapat mengirim pesan kembali dengan salah satu implementasi dari IHttpActionResult.

Apakah saya perlu melakukan ini (dan membuat pesan respons sendiri):

    public IHttpActionResult Get()
    {
       HttpResponseMessage responseMessage = ...
       return ResponseMessage(responseMessage);
    }

atau adakah cara yang lebih baik?

Anda bisa menggunakan ini:

return Content(HttpStatusCode.BadRequest, "Any object");

Anda dapat menggunakan HttpRequestMessagesExtensions.CreateErrorResponse ( System.Net.Httpnamespace), seperti:

public IHttpActionResult Get()
{
   return ResponseMessage(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Message describing the error here"));
}

Lebih disukai membuat tanggapan berdasarkan permintaan untuk memanfaatkan negosiasi konten API Web.

Saya akhirnya pergi dengan solusi berikut:

public class HttpActionResult : IHttpActionResult
{
    private readonly string _message;
    private readonly HttpStatusCode _statusCode;

    public HttpActionResult(HttpStatusCode statusCode, string message)
    {
        _statusCode = statusCode;
        _message = message;
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        HttpResponseMessage response = new HttpResponseMessage(_statusCode)
        {
            Content = new StringContent(_message)
        };
        return Task.FromResult(response);
    }
}

... yang bisa digunakan seperti ini:

public IHttpActionResult Get()
{
   return new HttpActionResult(HttpStatusCode.InternalServerError, "error message"); // can use any HTTP status code
}

Saya terbuka untuk saran untuk perbaikan. :)

Anda juga dapat melakukan:

return InternalServerError(new Exception("SOME CUSTOM MESSAGE"));

Siapa pun yang tertarik mengembalikan apa pun dengan kode status apa pun dengan mengembalikan ResponseMessage:

//CreateResponse(HttpStatusCode, T value)
return ResponseMessage(Request.CreateResponse(HttpStatusCode.XX, object));

Di ASP.NET Web API 2, Anda bisa membungkusnya ResponseMessagedengan ResponseMessageResult :

public IHttpActionResult Get()
{
   HttpResponseMessage responseMessage = ...
   return new ResponseMessageResult(responseMessage);
}

Dalam beberapa kasus ini mungkin cara paling sederhana untuk mendapatkan hasil yang diinginkan, meskipun umumnya lebih baik menggunakan berbagai hasil di System.Web.Http.Hasil .

Sederhana:

return ResponseMessage(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Your message"));

Ingatlah untuk merujuk System.Net.Http dan System.Net .

Saya akan merekomendasikan membaca posting ini. Ada banyak cara untuk menggunakan HttpResponse yang ada seperti yang disarankan, tetapi jika Anda ingin memanfaatkan Web Api 2, maka coba gunakan beberapa opsi IHttpActionResult bawaan seperti

return Ok() 

atau

return NotFound()

Pilih jenis pengembalian yang tepat untuk Pengontrol Web Api

Contoh yang lebih rinci dengan dukungan kode HTTP yang tidak didefinisikan dalam C # HttpStatusCode.

public class MyController : ApiController
{
    public IHttpActionResult Get()
    {
        HttpStatusCode codeNotDefined = (HttpStatusCode)429;
        return Content(codeNotDefined, "message to be sent in response body");
    }
}

Contentadalah metode virtual yang didefinisikan dalam kelas abstrak ApiController, basis controller. Lihat deklarasi seperti di bawah ini:

protected internal virtual NegotiatedContentResult<T> Content<T>(HttpStatusCode statusCode, T value);

@abelabelle Anda dapat membuat beton IHttpActionResult dan membungkus kode-kode seperti ini:

public class NotFoundPlainTextActionResult : IHttpActionResult
{
    public NotFoundPlainTextActionResult(HttpRequestMessage request, string message)
    {
        Request = request;
        Message = message;
    }

    public string Message { get; private set; }
    public HttpRequestMessage Request { get; private set; }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult(ExecuteResult());
    }

    public HttpResponseMessage ExecuteResult()
    {
        var response = new HttpResponseMessage();

        if (!string.IsNullOrWhiteSpace(Message))
            //response.Content = new StringContent(Message);
            response = Request.CreateErrorResponse(HttpStatusCode.NotFound, new Exception(Message));

        response.RequestMessage = Request;
        return response;
    }
}

Saya memiliki masalah yang sama. Saya ingin membuat hasil khusus untuk pengontrol api saya, untuk memanggil mereka suka return Ok("some text");

Lalu saya melakukan ini: 1) Buat jenis hasil khusus dengan singletone

public sealed class EmptyResult : IHttpActionResult
{
    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult(new HttpResponseMessage(System.Net.HttpStatusCode.NoContent) { Content = new StringContent("Empty result") });
    }
}

2) Buat pengontrol khusus dengan metode baru:

public class CustomApiController : ApiController
{
    public IHttpActionResult EmptyResult()
    {
        return new EmptyResult();
    }
}

Dan kemudian saya dapat memanggil mereka di pengontrol saya, seperti ini:

public IHttpActionResult SomeMethod()
    {
       return EmptyResult();
    }

jawaban ini didasarkan pada jawaban Shamil Yakupov, dengan objek nyata bukan string.

using System.Dynamic;

dynamic response = new ExpandoObject();
response.message = "Email address already exist";

return Content<object>(HttpStatusCode.BadRequest, response);

Sebagai pengecualian, saya biasanya melakukannya

 catch (Exception ex)
        {
            return InternalServerError(new ApplicationException("Something went wrong in this request. internal exception: " + ex.Message));
        }

Hal-hal di atas sangat membantu.

Saat membuat layanan web, Jika Anda mengambil kasus layanan konsumen akan sangat dihargai. Saya berusaha menjaga keseragaman output. Anda juga dapat memberikan komentar atau pesan kesalahan aktual. Konsumen layanan web hanya dapat memeriksa apakah IsSuccess benar atau tidak, yang lain akan yakin ada masalah, dan bertindak sesuai situasi.

  public class Response
    {
        /// <summary>
        /// Gets or sets a value indicating whether this instance is success.
        /// </summary>
        /// <value>
        /// <c>true</c> if this instance is success; otherwise, <c>false</c>.
        /// </value>
        public bool IsSuccess { get; set; } = false;

        /// <summary>
        /// Actual response if succeed 
        /// </summary>
        /// <value>
        /// Actual response if succeed 
        /// </value>
        public object Data { get; set; } = null;

        /// <summary>
        /// Remark if anythig to convey
        /// </summary>
        /// <value>
        /// Remark if anythig to convey
        /// </value>
        public string Remark { get; set; } = string.Empty;
        /// <summary>
        /// Gets or sets the error message.
        /// </summary>
        /// <value>
        /// The error message.
        /// </value>
        public object ErrorMessage { get; set; } = null;


    }  




[HttpGet]
        public IHttpActionResult Employees()
        {
            Response _res = new Response();
            try
            { 
                DalTest objDal = new DalTest(); 
                _res.Data = objDal.GetTestData();
                _res.IsSuccess = true;
                return Ok<Response>(_res);
            }
            catch (Exception ex)
            {
                _res.IsSuccess = false;
                _res.ErrorMessage = ex;
                return ResponseMessage(Request.CreateResponse(HttpStatusCode.InternalServerError, _res )); 
            } 
        }

Anda dipersilakan untuk memberikan saran jika ada :)

Maaf untuk jawaban yang terlambat kenapa tidak Anda gunakan sederhana

return BadRequest("your message");

Saya menggunakannya untuk semua milik saya IHttpActionResult kesalahan ini berfungsi dengan baik

di sini adalah dokumentasi: https://msdn.microsoft.com/en-us/library/system.web.http.apicontroller.badrequest(v=vs.118).aspx