【WebAPI】RESTful 风格的 API 设计方案

目录RESTful设计要点1.网址中不能有动词，只能有名词，且应使用复数。2.get请求中参数一般都在url中RESTful风格API示例那什么是GET，PUT，POST，DELETE呢开始创建项目创建Help页面路由路由前缀隐藏API参数多参数参数约束可选参数api的多版本管理是否一定使用RESTful风格设计参考文章...

GreAmbWang

1177人浏览 · 2019-12-15 15:01:47

GreAmbWang · 2019-12-15 15:01:47 发布

RESTful设计要点

1.网址中不能有动词，只能有名词，且应使用复数。

2.get请求中参数一般都在url中

RESTful风格API示例

那什么是GET，PUT，POST，DELETE呢

RESTful设计要点

1.网址中不能有动词，只能有名词，且应使用复数。

例如：下面都是不符合RESTful风格的

https://xxx.com/api/getusers

https://xxx.com/api/getuserbyid

https://xxx.com/api/updateuser

2.get请求中参数一般都在url中

例如：

https://xxx.com/api/users 获取用户信息列表

https://xxx.com/api/users/true/18 获取性别为男性且年龄为18岁的用户信息列表多参数

https://xxx.com/api/users/1001 获取ID为1001的用户信息单参数

下面这种写法则不符合RESTful风格

https://xxx.com/api/users?isman=true&age=18

https://xxx.com/api/users?id=1001

RESTful风格API示例

GET https://xxx.com/api/users //获取所有用户信息列表

GET https://xxx.com/api/users/1001/details //获取ID为1001的用户信息

PUT https://xxx.com/api/users/1001 //修改ID为1001的用户信息

POST https://xxx.com/api/users //添加用户信息

DELETE https://xxx.com/api/users/1001 //删除ID为1001的用户信息

那什么是GET，PUT，POST，DELETE呢

对于我一开始接触这几个词的时候，也是懵懵懂懂

一开始接触WebAPI，我属于后端开发，前端的什么js，请求等懂得少，看来还是要多了解

GET，PUT，POST，DELETE就是前端请求数据的几种方式，对应着RESTful API的增删改查

在网上查资料的时候，很多都是这么写，对于一个后端开发人员来说，还是不懂，下面容我一一讲解

前端请求数据时，有各种参数，其中有一个type参数，可以填写请求的方式

例如：

获取用户信息列表

$.ajax({
    url: "/api/users/",         //请求地址
    type: "GET",                //请求方式
    data: {},                   //参数
    success: function (data) {  //请求成功时，做什么

    },
    error: function (data) {    //请求失败时，做什么

    }
});

修改用户信息

$.ajax({
    url: "/api/users/1001",             //请求地址
    type: "PUT",                        //请求方式
    data: {"ID": 1001, "name": "haha"}, //参数
    success: function (data) {          //请求成功时，做什么

    },
    error: function (data) {            //请求失败时，做什么

    }
});

添加用户信息

$.ajax({
    url: "/api/users",                  //请求地址
    type: "POST",                       //请求方式
    data: {"name": "haha"},             //参数
    success: function (data) {          //请求成功时，做什么

    },
    error: function (data) {            //请求失败时，做什么

    }
});

删除用户信息

$.ajax({
    url: "/api/users/1001",             //请求地址
    type: "DELETE",                     //请求方式
    data: {},                           //参数
    success: function (data) {          //请求成功时，做什么

    },
    error: function (data) {            //请求失败时，做什么

    }
});

开始创建项目

看看微软提供的示例

方法分别是Get，Post，Put，Delete，分别对应增删改查

public class ValuesController : ApiController
{
    // GET: api/Values
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

    // GET: api/Values/5
    public string Get(int id)
    {
        return "value";
    }

    // POST: api/Values
    public void Post([FromBody]string value)
    {
    }

    // PUT: api/Values/5
    public void Put(int id, [FromBody]string value)
    {
    }

    // DELETE: api/Values/5
    public void Delete(int id)
    {
    }
}

以Get，Post，Put，Delete为前缀命名的方法会自动识别，你可以在方法上添加[HttpGet]，[HttpPut]，[HttpPost]，[HttpDelete]特性，

比如，