在 Ruby on Rails 中如何编写 RESTful API

什么是 RESTful API

RESTful API 是一种设计风格，用来构建 Web 应用程序中的 API。它基于 HTTP 协议，遵循一些约定，使得开发者可以快速构建出易用的 API，同时也方便客户端进行调用。

RESTful API 是基于资源的，每一个 URL 表示一个资源，采用相应的 HTTP 方法来实现对该资源的操作。常见的 HTTP 方法有 GET、POST、PUT、DELETE 等。

Ruby on Rails 是一个使用 Ruby 编写的 web 应用程序框架，它支持快速构建高效的 RESTful Web 应用程序。在 Rails 中编写 RESTful API 实际上就是编写控制器和路由。

设计路由

在编写 RESTful API 的时候，首先需要设计好路由。下面是一个基本的 RESTful API 路由设计：

resources :users

以上代码定义了一个基础的 User 资源。这个资源支持以下 HTTP 方法：

• GET /users # 获取所有用户
• GET /users/:id # 获取单个用户
• POST /users # 创建用户
• PUT /users/:id # 更新用户
• DELETE /users/:id # 删除用户

可以看到，这个路由设计符合 RESTful API 的规范。

编写控制器

接下来需要编写控制器来处理 HTTP 请求。在 Rails 中，控制器通常位于 app/controllers 目录下。

以下是一个基本的 User 控制器：

// javascriptcn.com 代码示例
class UsersController < ApplicationController
  # 获取所有用户
  def index
    @users = User.all
    render json: @users
  end

  # 获取单个用户
  def show
    @user = User.find(params[:id])
    render json: @user
  end

  # 创建用户
  def create
    @user = User.new(user_params)
    if @user.save
      render json: @user, status: :created, location: @user
    else
      render json: @user.errors, status: :unprocessable_entity
    end
  end

  # 更新用户
  def update
    @user = User.find(params[:id])
    if @user.update(user_params)
      render json: @user
    else
      render json: @user.errors, status: :unprocessable_entity
    end
  end

  # 删除用户
  def destroy
    @user = User.find(params[:id])
    @user.destroy
  end

  private

  def user_params
    params.require(:user).permit(:name, :email)
  end
end

上面的控制器包含了所有基本的 RESTful API 方法：index、show、create、update 和 destroy。其中，create 和 update 方法需要通过 user_params 方法获取请求参数。

用 Postman 测试 API

在编写完路由和控制器之后，可以用 Postman 工具来测试 API 是否正确。首先需要启动服务器，在终端中输入以下命令：

rails s

然后打开 Postman 工具，创建一个新的请求，并设置请求 URL 和请求方法。例如，要获取所有用户，就需要设置请求 URL 为 http://localhost:3000/users，并选择 GET 方法。然后点击发送请求，就可以看到请求结果了。

总结

在本文中，我们介绍了 RESTful API 的概念，以及在 Ruby on Rails 中如何编写 RESTful API，其中包括路由和控制器的编写。最后，我们用 Postman 工具来测试了这个 API，确保它能够正常工作。希望本文能够帮助读者更好地理解 RESTful API 的设计和开发。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/653cfd057d4982a6eb6e81a8