如何使用 Ruby on Rails 构建 RESTful API？-JavaScript中文网-JavaScript教程资源分享门户

随着 Web 应用程序的迅速发展，RESTful API 成为了现代化应用的构建基础之一。Ruby on Rails 是一种流行的 Web 应用程序框架，使得使用 Ruby 编程语言轻松构建和部署 Web 应用程序。在本篇文章中，我们将深入研究如何使用 Ruby on Rails 构建 RESTful API。

什么是 RESTful API?

REST (Representational State Transfer) 是一种基于网络的软件架构风格。RESTful API 是一种 Web 服务，可以使用 HTTP 请求执行操作，如创建、读取、更新和删除数据。考虑一个简单的 User 对象，具有 id、name 和 email 属性：

{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com"
}

通过 RESTful API 暴露此 User 对象的简单方式如下：

GET /users - 检索所有 User 列表
POST /users - 创建新 User
GET /users/1 - 获取 id=1 的 User
PUT /users/1 - 更新 id=1 的 User
DELETE /users/1 - 删除 id=1 的 User

Ruby on Rails 中的 RESTful API

Ruby on Rails 通过正交架构提供了优美的路由控制和控制器层来简化 RESTful API 的构建。在构建 RESTful API 时需要使用以下组件：

控制器：处理请求和返回响应，从模型中检索和更新数据
路由：将 URL 映射到控制器方法
模型：表示数据和行为

控制器

控制器是 Rails 应用程序的基本单元，负责处理 HTTP 请求和响应。在 RESTful API 中，每个控制器方法被分配为一个 HTTP 动词，并针对一个 URL。控制器方法通常执行以下操作：

从 HTTP 请求中提取参数
调用模型中的方法
渲染 JSON 或其他格式的响应

例如，考虑 UsersController 控制器，负责处理 User 对象的创建，检索和更新：

-- -------------------- ---- -------
----- --------------- - ---------------------

  --- ------
    ----- - ---------------------

    -- ----------
      ------ ----- ------ ------- --------
    ----
      ------ ----- ------------- ------- ---------------------
    ---
  ---

  --- ----
    ----- - ----------------------
    ------ ----- -----
  ---

  --- ------
    ----- - ----------------------

    -- -------------------------
      ------ ----- -----
    ----
      ------ ----- ------------- ------- ---------------------
    ---
  ---
    
  -------

  --- -----------
    ----------------------------------- -------
  ---
    
---

路由

路由是将 URL 映射到控制器方法的中心机制。在 Rails 中，可以使用 config/routes.rb 中的 DSL 配置路由。下面是一个简单的配置：

Rails.application.routes.draw do
  resources :users, only: [:create, :show, :update, :destroy]
end

此配置使用了 resources 方法，它为 UsersController 控制器的四个方法生成路径。.only 方法表明只处理 create、show、update 和 destroy 请求。

模型

模型是 Rails 应用程序中的另一个核心组件，它负责处理业务逻辑和与持久存储相关的细节。模型可以用 ActiveRecord 创建和管理数据库，从而使用数据库表格中的数据。

例如，考虑一个简单的 User 模型：

class User < ApplicationRecord
  validates :name, presence: true
  validates :email, presence: true, uniqueness: true
end

这个模型包括两个验证器：确保每个 User 有一个非空的 name 属性，并确保每个 User 的 email 属性是唯一的且不为空。

使用 curl 测试

最后，使用 curl 命令测试构建的 RESTful API。首先启动 Ruby on Rails 应用程序服务器：

$ rails server

然后，使用以下命令从命令行检索所有 Users：

$ curl localhost:3000/users

如果添加 -v 选项，则会在输出中包含完整的 HTTP 响应。

使用以下命令用户创建一个新 User：

$ curl -H "Content-Type: application/json" -X POST \
    -d '{"user":{"name":"John Doe","email":"john.doe@example.com"}}' \
    localhost:3000/users

这个命令使用 POST 请求，数据包含 JSON 格式的 User 对象。如果成功，则服务器将返回新创建的 User 对象。

与其他 Web 框架相比，Ruby on Rails 的优雅性在于其简单、一致、可预测的 RESTful API 接口，以及快速、敏捷地开发数据驱动应用程序的能力。

结论

本篇文章介绍了如何使用 Ruby on Rails 构建 RESTful API。我们详细介绍了控制器、路由和模型的工作原理，以及如何使用 curl 命令测试 API。Ruby on Rails 是构建现代化、高性能、可扩展的 RESTful API 的绝佳选择。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6745620dc1a23897ea938814