Ruby on Rails 是一个开源的全栈 web 框架，它凭借着强大的代码生成器和完善的文档，让 web 开发变得更加高效和简单。其中之一的优势是提供了一套基于 RESTful 架构风格的 API 构建工具，十分适合前端开发者利用该工具快速开发接口。
在本文中，我们将介绍如何使用 Ruby on Rails 开发 RESTful API，其中包括路由定义、控制器和模型创建、以及数据的增删改查等。
路由定义
在开始 API 开发之前，需要定义合适的路由，以便请求能够正确地映射到相应的控制器中。Rails 提供了一套非常灵活的路由系统，可以通过自定义路由格式定义 RESTful API 的各个资源点。
在 routes.rb 文件中，可以使用 resources 方法定义 RESTful 资源，如下：
Rails.application.routes.draw do
namespace :api do
namespace :v1 do
resources :tasks
end
end
end在上述代码中，我们定义了一个名为 tasks 的资源，它在 api/v1 命名空间下。并将该资源所映射到 api/v1/tasks_controller.rb 中的 TasksController 控制器中，控制器的动作以及所对应的 HTTP 方法如下表所示：
| 动作 | HTTP 方法 | API 路径 |
|---|---|---|
| Index | GET | /api/v1/tasks |
| Show | GET | /api/v1/tasks/:id |
| Create | POST | /api/v1/tasks |
| Update | PATCH/PUT | /api/v1/tasks/:id |
| Destroy | DELETE | /api/v1/tasks/:id |
创建控制器和模型
在路由定义完成之后，需要创建相应的控制器和模型。在命名空间 Api::V1 下创建 tasks_controller.rb 文件，并编写如下代码：
-- -------------------- ---- -------
------ ---
------ --
----- --------------- - ---------------------
------------- ---------- ----- ------- -------- ---------
- --- -------------
--- -----
------ - --------
------ ----- ------
---
- --- -----------------
--- ----
------ ----- -----
---
- ---- -------------
--- ------
----- - ---------------------
-- ----------
------ ----- ------ ------- --------
----
------ ----- ------------- ------- ---------------------
---
---
- --------- -----------------
--- ------
-- -------------------------
------ ----- -----
----
------ ----- ------------- ------- ---------------------
---
---
- ------ -----------------
--- -------
-------------
---
-------
--- --------
----- - ----------------------
---
--- -----------
------------------------------------ -------------
---
---
---
---上述代码中，我们定义了 TasksController 控制器，并实现了 index、show、create、update 和 destroy 五个动作。其中，@task 变量代表 Task 模型对象，我们可以通过参数解析器 params[:id] 获取该对象的主键。
同时，在这些动作中，我们通过 render 关键字返回了相应的 JSON 格式的数据，其中 status 参数指定的是 HTTP 响应码。当然，我们还定义了一个 before_action 回调方法 set_task，用于统一获取指定的 Task 模型对象。
接下来，我们需要在 app/models 目录下创建 task.rb 文件，并定义 Task 模型对象，如下代码：
class Task < ApplicationRecord validates :title, :description, presence: true end
在 Task 模型对象中，我们定义了该对象的校验规则，presence: true 表示该属性值不允许为空。在使用控制器创建或修改数据时，会在参数解析器中自动校验参数的合法性，如果不符合校验规则，就会返回请求参数的不合法提示信息。
数据的增删改查
当控制器和模型对象都创建完成后，我们就可以通过 RESTful API 对数据进行增删改查了。在控制器中，我们已经实现了增删改查等动作，这些动作可以直接对应 HTTP 请求方法。我们可以使用常见的 API 开发框架，如 axios、jQuery.ajax 或 fetch，通过 HTTP 请求对 API 进行访问。
以 axios 为例，可以使用如下代码访问 RESTful API：
-- -------------------- ---- -------
------ ----- ---- --------
-- ------
---------------------------------------- -- -
---------------------------
---
-- ------
------------------------------------------ -- -
---------------------------
---
-- ----
--------------------------- -
----- -
------ --------
------------ -------
-
---------------- -- -
---------------------------
---
-- ----
------------------------------ -
----- -
------ --------
------------ -------
-
---------------- -- -
---------------------------
---
-- ----
--------------------------------------------- -- -
---------------------------
---上述代码中，我们使用了 axios 库对 RESTful API 进行了访问，其中，HTTP 请求方法直接对应了控制器的五个动作。
当然，在实际 API 开发中，我们可能还需要对其他可能出现的异常情况进行错误处理，比如服务器繁忙、取消请求等等。此时，我们可以在控制器或路由处理器中，统一处理这些异常情况，方便管理和维护。
总结
在本文中，我们介绍了如何使用 Ruby on Rails 框架开发 RESTful 风格的 API，其中包括路由的定义、控制器和模型的创建，以及数据的增删改查等。尽管这个过程需要一定的学习和实践，但是一旦掌握了 RESTful API 的开发技巧，就可以极大地提高开发效率和实现速度，同时提升开发者的技术水平和得分贡献。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64634f86968c7c53b0453e4f