如何用WebApi实现请求/响应模式

本文关键字:响应 模式 请求 实现 何用 WebApi | 更新日期: 2023-09-27 18:29:30

我是MVC Web Api的新手,但我有一些使用ServiceStack框架的经验。一些webapi示例看起来很像RPC,有更多的操作方法和更少的参数。事实上,大多数示例似乎都将request参数限制为id。我想使用request/response创建一些报告服务,因为请求在所有报告条件下都会变得非常复杂。

以下是我简化的请求/响应类型:

public class PendingRequest
{
    public string Id { get; set; }
    public int AccountId { get; set; }
    public DateTime? FromDate { get; set; }
    public DateTime? ToDate { get; set; }
}
public class PendingResponse
{
    public string Id { get; set; }
    public IEnumerable<Pending> Data { get; set; }
}

我的大纲报告控制器:

public class ReportsController : ApiController
{
    public async Task<PendingResponse> GetPending(PendingRequest request)
    {
        return new PendingResponse
        {
            Id = request.Id,
            // Data = await Repo.GetPending()
        };
    }
    public async Task<ShippedResponse> GetShipped(ShippedRequest request)
    {
        return new ShippedResponse
        {
            Id = request.Id,
            // Data = await Repo.GetShipped()
        };
    }
    public async Task<ProductsResponse> GetProducts(ProductsRequest request)
    {
        return new ProductsResponse
        {
            Id = request.Id,
            // Data = await Repo.GetProducts()
        };
    }
}

以及我为一个自托管应用程序的路由和配置:

class Program
{
    static void Main()
    {
        var config = new HttpSelfHostConfiguration("http://localhost:8080");
        config.Routes.MapHttpRoute(
            name: "Reports",
            routeTemplate: "api/reports/{action}",
            defaults: new
                {
                    controller = "Reports"
                });
        using (var server = new HttpSelfHostServer(config))
        {
            server.OpenAsync().Wait();
            Console.WriteLine("Press Enter to quit.");
            Console.ReadLine();
        }
    }
}

因此,通过此路由,我打算将操作作为报告的名称。注意,这里没有包含请求参数。不确定我该不该。

问题实际上出在客户端。对于HttpClient,GetAsync方法不允许我包含JSON请求对象。我看到了一个扩展方法PostAsJsonAsync,但这肯定不应该是POST吗?如果没有GetAsJsonAsync或类似程序,我就看不到用GET包含请求的方法?

老实说,我更喜欢ServiceStack,但似乎还没有异步支持。我需要开发一些I/O密集型的高性能服务,我想尽可能减少阻塞。

更新:

如果我不使用请求体,而是将模型的参数作为查询字符串的一部分,那么WebApi似乎将执行模型绑定。为了实现这一点,Get方法需要在模型类型前面加上[FromUri]属性,该属性通知模型绑定器应该根据请求查询字符串构造模型。混乱,但有效。

[ActionName("Pending")]
public async Task<PendingResponse> GetPending([FromUri] PendingRequest request)
{
    return new PendingResponse
    {
        Id = request.Id,
        // query = ...build from request params
        // Data = await Repo.GetPending(query)
    };
}

现在在客户端,我执行以下操作:

var result = await _httpClient.GetAsync("api/reports/pending?Id=123&AccountId=456");
result.EnsureSuccessStatusCode();
var response = await result.Content.ReadAsAsync<PendingResponse>();

对服务的调用会导致GetPending方法被调用,其中PendingRequest对象的副本由提供的查询字符串参数实现。

如何用WebApi实现请求/响应模式

这里的根本问题是您试图向HTTPGET提供请求体,这是不允许的。好吧,你仍然可以继续格式化一个带有请求体的GET并提交它,但这不符合规范。严格来说,HTTP规范并没有禁止GET请求有正文,但GET请求的响应不能根据请求体而改变,这基本上意味着你不能在GET请求体中使用搜索条件。您可以使用URI路径和查询字符串来指定搜索条件,如果您想将它们绑定到一个复杂的类型参数中,则需要使用[FromUri],如下所示:public async Task<PendingResponse> GetPending([FromUri]PendingRequest request)

有点猜测,但对JSON请求对象进行URL编码并将其放入GET URI的查询字符串段中呢?

此外,您可能需要操作中请求方法参数上的[FromUri]属性,因为它是一个复杂类型。我可能遗漏了一些内容,但这篇关于参数绑定的文章没有提到GET是复杂类型的特殊情况,因此我认为他们总是会尝试阅读POST正文。