Có cách nào để buộc ASP.NET Web API trả về văn bản thuần túy không?

Question

Tôi cần nhận lại phản hồi bằng văn bản thuần tuý từ bộ điều khiển ASP.NET Web API.

Tôi đã thử thực hiện yêu cầu với Accept: text/plain nhưng có vẻ như không phải là mẹo. Bên cạnh đó, yêu cầu nằm ngoài và ngoài tầm kiểm soát của tôi. Những gì tôi sẽ thực hiện là bắt chước theo cách cũ của ASP.NET:

context.Response.ContentType = "text/plain"; 
context.Response.Write("some text); 

Bất kỳ ý tưởng nào?

EDIT, giải pháp: Dựa trên câu trả lời Aliostad, tôi thêm vào các định dạng WebAPIContrib văn bản, khởi tạo nó trong Application_Start:

config.Formatters.Add(new PlainTextFormatter()); 

và điều khiển của tôi đã kết thúc một cái gì đó như:

[HttpGet, HttpPost] 
public HttpResponseMessage GetPlainText() 
{ 
    return ControllerContext.Request.CreateResponse(HttpStatusCode.OK, "Test data", "text/plain"); 
} 

Answer 1

Hmmm ... Tôi không nghĩ rằng bạn cần phải tạo ra một định dạng tùy chỉnh để làm cho công việc này. Thay vào đó, hãy trả lại nội dung như sau:

[HttpGet] 
    public HttpResponseMessage HelloWorld() 
    { 
     string result = "Hello world! Time is: " + DateTime.Now; 
     var resp = new HttpResponseMessage(HttpStatusCode.OK); 
     resp.Content = new StringContent(result, System.Text.Encoding.UTF8, "text/plain"); 
     return resp; 
    } 

Điều này làm việc cho tôi mà không cần sử dụng trình định dạng tùy chỉnh.

Nếu bạn rõ ràng muốn tạo đầu ra và ghi đè thương lượng nội dung mặc định dựa trên tiêu đề Chấp nhận, bạn sẽ không muốn sử dụng Request.CreateResponse() vì nó buộc loại mime.

Thay vào đó, hãy tạo một cách mới một cách thủ công HttpResponseMessage và gán nội dung theo cách thủ công. Ví dụ trên sử dụng StringContent nhưng có khá nhiều lớp nội dung khác có sẵn để trả về dữ liệu từ các loại/cấu trúc dữ liệu .NET khác nhau.

Answer 2

Khi chấp nhận: văn bản/đồng bằng không hoạt động, sau đó không có trình định dạng đã đăng ký cho loại mime văn bản.

Bạn có thể đảm bảo rằng không có trình định dạng cho loại mime được chỉ định bằng cách nhận danh sách tất cả các trình định dạng được hỗ trợ từ cấu hình dịch vụ.

Tạo trình định dạng loại phương tiện rất đơn giản hỗ trợ các loại văn bản.

http://www.asp.net/web-api/overview/formats-and-model-binding/media-formatters

Answer 3

• Hãy cẩn thận không sử dụng bối cảnh trong ASP.NET Web API hoặc bạn sẽ sớm hay muộn được xin lỗi. Bản chất không đồng bộ của ASP.NET Web API làm cho việc sử dụng HttpContext.Current là một trách nhiệm pháp lý.
• Sử dụng trình định dạng văn bản thuần túy và thêm vào trình định dạng của bạn. Có hàng chục người xung quanh. Bạn thậm chí có thể viết của bạn một cách dễ dàng. WebApiContrib có một.
• Bạn có thể ép buộc bằng cách đặt tiêu đề loại nội dung trên httpResponseMessage.Headers thành text/plain trong bộ điều khiển của bạn miễn là bạn đã đăng ký định dạng văn bản thuần túy.

Answer 4

Nếu bạn chỉ tìm kiếm một trình định dạng đơn giản/văn bản đơn giản mà không cần thêm phụ thuộc, điều này sẽ thực hiện thủ thuật.

public class TextPlainFormatter : MediaTypeFormatter 
{ 
    public TextPlainFormatter() 
    { 
     this.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/plain")); 
    } 

    public override bool CanWriteType(Type type) 
    { 
     return type == typeof(string); 
    } 

    public override bool CanReadType(Type type) 
    { 
     return type == typeof(string); 
    } 

    public override Task WriteToStreamAsync(Type type, object value, Stream stream, HttpContentHeaders contentHeaders, TransportContext transportContext) 
    { 
     return Task.Factory.StartNew(() => { 
      StreamWriter writer = new StreamWriter(stream); 
      writer.Write(value); 
      writer.Flush(); 
     }); 
    } 

    public override Task<object> ReadFromStreamAsync(Type type, Stream stream, HttpContentHeaders contentHeaders, IFormatterLogger formatterLogger) 
    { 
     return Task.Factory.StartNew(() => { 
      StreamReader reader = new StreamReader(stream); 
      return (object)reader.ReadToEnd(); 
     }); 
    } 
} 

---

Đừng quên để thêm nó vào toàn cầu web api cấu hình của bạn.

config.Formatters.Add(new TextPlainFormatter()); 

Bây giờ bạn có thể vượt qua đối tượng chuỗi

this.Request.CreateResponse(HttpStatusCode.OK, "some text", "text/plain"); 

Answer 5

Đối với lõi .net:

[HttpGet("About")] 
public ContentResult About() 
{ 
    return Content("About text"); 
} 

https://docs.microsoft.com/en-us/aspnet/core/mvc/models/formatting

Answer 6

Một phần mở rộng như sau ai có thể giảm số lượng các đường dây và làm đẹp mã của bạn:

public static class CommonExtensions 
{ 
    public static HttpResponseMessage ToHttpResponseMessage(this string str) 
    { 
     var resp = new HttpResponseMessage(HttpStatusCode.OK) 
     { 
      Content = new StringContent(str, System.Text.Encoding.UTF8, "text/plain") 
     }; 

     return resp; 
    } 
} 

Bây giờ bạn có thể tiêu thụ tiện ích được xác định trong Web API:

của bạn

public class HomeController : ApiController 
{ 
    [System.Web.Http.HttpGet] 
    public HttpResponseMessage Index() 
    { 
     return "Salam".ToHttpResponseMessage(); 
    } 
} 

Bằng cách định tuyến {DOMAIN}/api/Home/Index bạn sẽ nhìn thấy văn bản đơn giản sau đây:

MyPlainTextResponse