随着移动互联网的兴起,RESTful风格的API设计也随之流行起来,但我们说了那么多RESTful设计,它到底是什么?本篇文章带大家来了解一下它的真实面目。

RESTful概念

首先,我们需要明确的是RESTful,它是一个理念,是一个设计规范,而并不是什么协议等。

REST,全称Representational State Transfer,直接翻译就是:表现层状态转化。而该翻译之所以晦涩是因为缺少了主语,准确来说应该是“Resource Representational State Transfer”。

通俗来讲,就是“资源在网络中以某种表现形式进行状态转化”。

REST概念是Roy Thomas Fielding在他2000年的博士论文中提出的,他是HTTP协议(1.0版和1.1版)的主要设计者。
有了对RESTful基础概念的了解,我们分别来看看其相关概念的解释。

资源

“资源”是RESTful中最核心的概念之一。在RESTful概念中,互联网中的每一样信息都可以定义为资源,比如文本、图片、音频、视频等。而这些资源又都可以对应一个特定的URI(统一资源定位符),URI为每一个资源的地址或独一无二的识别符。

##表现层

针对上面的“资源”,我们要进行相应的呈现,而且可以采用多种的呈现形式,而这些呈现形式就叫做“表现层”。

就拿文本为例,我们可以呈现为JSON格式、XML格式、HTML格式,甚至二进制格式等。这就是表现层所做的事情。

状态转化

资源通常放在服务器端,而客户端对服务器资源的增、删、改、查等操作,便涉及到资源状态的转化。这个过程便是“ 状态转化”。

我们以HTTP协议为例(RESTful不仅仅适用HTTP协议,只不过经常以HTTP协议为衬托),客户端可通过一些操作让服务器端的资源发生变化。

而这整个过程,便是“表现层状态转化”。

在HTTP中,提供了四种常见的操作方式:GET、POST、PUT、DELETE。

这四种操作方式分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。

为什么要使用RESTful风格呢

这是因为RESTful风格的设计拥有以下特点:结构清晰、符合标准、易于理解、扩展方便。

试想一下,如果采用传统的JSP模式,页面内容和代码混合在一起,而此时项目功能需新增移动端、微信小程序等其他客户端,是否需要重新定义接口?

而采用RESTful的定义,不仅结构清晰,更重要的是易于扩展、适用性更广泛。

RESTful风格示例

以用户(User)的增删改查为例,我们可以设计出一下接口形式:每列分别对应,(请求类型:请求地址:功能描述)

  • get:       /user:获取所有用户信息,通常会配合查询条件;
  • post:     /user:创建用户信息;
  • put:       /user:更新用户信息;
  • get:       /user/1:获取资源标识(id)为1的用户信息;
  • delete:  /user/1:删除资源标识(id)为1的用户信息;

看起来是不是简洁、清晰、方便很多?

如果再和一些MVC框架结合起来,那就更加方便。下面展示部分通过 asp.net core 来实现Controller层的代码。

[ApiController]
[Route("[controller]")]
public class UserController : ControllerBase
{
    private readonly IUserService _userService;

    public UserController(IUserService userService)
    {
        _userService = userService;
    }

    /// <summary>
    /// 根据条件查询用户
    /// </summary>
    [HttpGet]
    public IEnumerable<UserDto> Get([FromQuery]UserCriteria criteria)
    {
        return _userService.Get(criteria);
    }
    
    /// <summary>
    /// 根据Id获取用户
    /// </summary>
    [HttpGet("{id}")]
    public UserDto Get(int id)
    {
    	return _userService.Get(id);
    }
    
    /// <summary>
    /// 创建新用户
    /// </summary>
    [HttpPost]
    public void Create(UserCreateDto dto)
    {
    	_userService.Create(dto);
    }
    
    /// <summary>
    /// 更新指定用户信息
    /// </summary>
    [HttpPut("{id}")]
    public void Update(int id,[FromBody]UserUpdateDto dto)
    {
    	_userService.Update(id, dto);
    }
    
    /// <summary>
    /// 删除指定用户
    /// </summary>
    [HttpDelete("{id}")]
    public void Delete(int id)
    {
    	_userService.Delete(id);
    }
}

转载自《什么是RESTful风格的API设计?》,有部分修改。