如何创建 web api 方法？

Question

您好，我正在开发一个 restfull wep api 应用程序。我是 web api 世界的新手，对 http 动词有点困惑。我的任务是使用 web api2 编写服务。我在 sql server 中有一张表，我正在尝试围绕这张表进行基本的 crud 操作。我想以 json 格式发送数据并将数据作为 json 返回。例如http://localhost:26079/api/User_Creation/1 按预期返回 json 格式的数据。我的任务是在 iis 中托管上述方法，以便任何人都可以访问该方法来检索数据。我很困惑，假设如果我想向 db 插入一些数据，那么方法是什么？我在控制器中有以下代码，我可以插入数据。

            public void Post(Noor_Users users)
            {
                if (ModelState.IsValid)
                {
                    entityObject.Noor_Users.Add(users);
                    int result = entityObject.SaveChanges();
                }
            }

当我插入数据时，我的 url 将是 http://localhost:26079/，但是我怎样才能将我的插入数据方法暴露给外界呢？我的要求如下。

URL:/user_creation
method:post
Request:parameters such as fname,lname as json
Response:0 for success 1 for failure and data(unique id assigned to each user)

我可以得到一些帮助吗？感谢考虑。

Answer 1

在考虑 REST 时，理解和设计它很重要，因为您正在对该位置的资源执行操作，而不是像进行远程函数调用一样。

所以我建议将 API 设置为 - http://localhost:26079/api/User

而不是 - http://localhost:26079/api/User_Creation

为了遵守 REST 原则。

这样做我非常清楚地说明 api 的用户将能够使用不同的动词即对资源（在这种情况下是用户）执行操作。 GET、POST、PUT 和 DELETE。

查看一些使用 API 的示例 -

• 如果我需要获取 ID 为 1 的用户，我会调用 api，例如 http://localhost:26079/api/User/1 和 GET 请求
• 要创建一个新用户，我会调用 http://localhost:26079/api/User 和 POST 请求并在请求正文中发送用户信息
• 要删除 id 为 1 的用户，我会调用 http://localhost:26079/api/User/1 并使用 Delete 请求
• 要更新 ID 为 1 的用户数据，请使用 PUT 请求调用 http://localhost:26079/api/User/1，并在请求正文中发送更新的用户信息

请注意，我们仅使用一个单个端点通过更改不同的 HTTP 动词对我们的用户执行不同的操作。

默认的 asp.net web api 模板为如何声明不同的动词方法提供了一些很好的提示，例如-

public class UserController : ApiController
{
    // GET api/<controller>/1
    public User Get(int id)
    {
    }

    // POST api/<controller>
    public void Post([FromBody]User user)
    {
    }

    // PUT api/<controller>/1
    public void Put(int id, [FromBody]User user)
    {
    }

    // DELETE api/<controller>/1
    public void Delete(int id)
    {
    }
}

有一些很好的信息here 和here 设计了restful api。

Answer 2

如果你想从 Angular 调用你的方法，你可以使用 $http.post() 方法：

$http.post('/someUrl', data, config).then(successCallback, errorCallback);

Here你可以找到更多信息。