先決條件

在開始之前,請確保您已完成以下準備工作:

  1. 安裝 Ruby
  2. 安裝 Rails(運行命令:sudo gem install rails)。
  3. 準備好一個 IDE(集成開發環境)用于編輯代碼。
  4. 安裝 Postman,用于測試 API 端點

完成以上步驟后,您就可以開始構建 API 了!


添加代碼

1. 創建 Rails API 項目

首先,我們需要生成一個新的 Rails API 項目。在終端中運行以下命令以創建項目:

rails new my_api --api

2. 配置 CORS

為了便于測試,我們需要設置 CORS(跨域資源共享)配置,允許來自所有來源的流量:

  1. 打開項目根目錄下的 Gemfile 文件。

  2. 找到 rack-cors 條目并取消注釋,使其看起來如下所示:

    [gem](http://www.dlbhg.com/provider/uid20241113157009d029d7)'rack-cors'
  3. 安裝依賴項:

    bundleinstall
  4. 打開 config/initializers/cors.rb 文件,取消注釋默認的 CORS 配置,并將 origins 設置為 "*",允許所有來源的流量:

    Rails.application.config.middleware.insert_before 0, Rack::Cors do
    allowdo
    origins '*'
    resource '*',
    headers::any,
    methods:[:get,:[post](http://www.dlbhg.com/provider/uid2024120814472139bfa9),:put,:patch,:delete,:options,:head]
    end
    end

注意:在生產環境中,建議根據實際需求限制來源并優化 CORS 配置。

3. 創建 GET 端點

定義路由

打開 config/routes.rb 文件,添加以下代碼以定義 GET 端點:

Rails.application.routes.draw do
 get 'api/getcreditscore', to: 'application#get_credit_score'
end

編寫控制器邏輯

導航到 app/controllers 目錄,打開 application_controller.rb 文件,添加以下代碼以實現隨機生成信用評分的邏輯:

class ApplicationController < ActionController::API
 def get_credit_score
 score = rand(500..900)
 render json: { credit_score: score }
 end
end

至此,API 的核心邏輯已經完成。


運行和測試代碼

啟動 Rails 服務器

在項目根目錄中運行以下命令以啟動 Rails 服務器:

rails server

默認情況下,服務器會在 localhost:3000 上運行。

測試 API

使用 Postman 或其他 HTTP 客戶端發送 GET 請求至以下 URL:

http://localhost:3000/api/getcreditscore

您應該會收到如下響應:

{
 "credit_score": 750
}

提示:返回的 credit_score 是一個 500 到 900 之間的隨機數。


總結

通過本教程,我們成功使用 Rails 構建了一個簡單的 RESTful API,并實現了隨機生成信用評分的功能。您可以通過擴展此項目,進一步學習如何與數據庫交互、添加更多功能以及優化 API 的性能。

原文鏈接: https://www.moesif.com/blog/technical/api-development/Building-A-RESTful-API-With-Rails/

上一篇:

構建RESTful API的4大最佳Ruby框架

下一篇:

如何使用Rust構建強大的GraphQL API
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費