如何发布ASP ?. NET Web API模型类定义

本文关键字：API 模型 定义 Web NET 何发布 ASP | 更新日期: 2023-09-27 18:14:01

我试图了解如何或有什么选项可用于发布传递给我的ASP的模型类。. NET Web API CRUD方法。下面是我的POST方法的一个例子。

public HttpResponseMessage PostMaterial(Material material)
{
    try
    {
        repository.Add(material);
    }
    catch (ArgumentNullException)
    {
        var exceptionResponse = Request.CreateResponse("Material object was null.");
        return exceptionResponse;
    }
    var response = Request.CreateResponse("Material " + material.MaterialName + " created.");
    string uri = Url.Link("DefaultApi", new { materialName = material.MaterialName });
    response.Headers.Location = new Uri(uri);
    return response;
}

在这个例子中，当外部API用户调用该方法时，一个物质对象作为参数传递。调用者需要一个材质类的定义，这样才能正确地构建他们需要传递的对象。如果有人有任何细节或更好的解释，请告诉我。

如何发布ASP ?. NET Web API模型类定义

我有同样的情况，有两种方法:

方法1:使用web API的帮助页

方法2:我可以创建一个简单的GET方法，在响应中返回我的模型(空白值或默认值)。这样他们(调用者)就会知道在他们的应用程序中需要发送什么参数/对象来使用web API。(但为此，我也需要告知他们关于该方法:))

因此，我选择第一种方法，因为它对外部应用程序开发人员正确理解您的web api非常有帮助。您也可以通过使用Web API帮助页面来正确地记录您的API。
相关文章：