Cách tạo một API đơn giản với Ruby on Rails
Cách tạo một API đơn giản với Ruby on Rails

Ruby on Rails là một khung ứng dụng web được thiết kế riêng cho phép người dùng tạo các ứng dụng được hỗ trợ bởi cơ sở dữ liệu dựa trên mẫu Model-View-Controller (MVC). Khung công tác Rails rất phù hợp cho người mới bắt đầu vì cấu trúc cụ thể không để lại nhiều lỗi và bản thân ngôn ngữ Ruby rất dễ tha thứ. Trước khi cài đặt Rails, hãy đảm bảo rằng bạn đã cài đặt các điều kiện tiên quyết sau trên hệ thống của mình: Ruby, SQLite3, Node.js và Yarn. Hãy xem hướng dẫn Bắt đầu với Rails để biết thêm thông tin. Khi bạn đã tính toán các điều kiện tiên quyết, chỉ cần gõ lệnh gem install rails do RubyGems cung cấp để bắt đầu.

Bây giờ chúng ta có thể tạo ứng dụng Rails của mình. Để làm như vậy, hãy chạy tên ứng dụng mới – api trong thư mục thích hợp. Gợi ý: không đặt tên ứng dụng của bạn sau một trong các lớp của bạn, vì tên của ứng dụng sẽ trở thành một từ dành riêng, do đó ngăn bạn không thể sử dụng nó làm tên lớp. Sau khi mã chạy, cd vào dự án mới của bạn và mở trình chỉnh sửa mã của bạn. Bạn có thể nhận thấy rằng Rails có cấu trúc tệp rất lớn. Quan trọng nhất, hãy lưu ý rằng thư mục ứng dụng chứa bộ điều khiển và các mô hình, thư mục cấu hình chứa các tuyến và thư mục db chứa các hạt giống (và cuối cùng là di chuyển và lược đồ).

Cách tạo một API đơn giản với Ruby on Rails
Cách tạo một API đơn giản với Ruby on Rails

Để xem danh sách các Rails chung các lệnh và mô tả của họ, chỉ cần gõ đường ray vào thiết bị đầu cuối của bạn. Các lệnh này sẽ giúp bạn khởi động bảng điều khiển rails, máy chủ, v.v. Để xem danh sách các lệnh Rails cho cơ sở dữ liệu của bạn, hãy nhập rails -T.

Bây giờ là lúc làm mô hình của bạn. Một mô hình là một lớp Ruby. Khi bạn đang tạo mô hình của mình, bạn cũng có thể chỉ định các thuộc tính và kiểu dữ liệu của chúng. Tôi sẽ tạo một mô hình chó, với tên, giống và tuổi là các thuộc tính. Để thực hiện việc này, tôi sẽ chạy rails g model tên chó giống age: integer. Vì tên và giống là chuỗi, chúng tôi không phải chỉ định kiểu dữ liệu của chúng, vì chuỗi là mặc định. Có nhiều kiểu dữ liệu khác nhau để lựa chọn, tùy thuộc vào nhu cầu của dự án của bạn. Điều này tạo ra sự di chuyển trong tệp di chuyển của bạn trong thư mục cơ sở dữ liệu và Lớp chó trong tệp dog.rb trong mô hình của bạn. Chạy rails db: di chuyển để chạy quá trình di chuyển này.

class CreateDogs <ActiveRecord :: Migration [6.0]
def change
create_table: dog do | t |
t.string: tên
t.string: giống
t.integer: tuổi
t.timestamps
end
end
end end

Bây giờ đã đến lúc thêm hạt giống vào tệp seed.rb của chúng ta. Đây là mã tôi đã sử dụng để điền hạt giống của mình với chó. Để chạy hạt giống của bạn, hãy nhập rails db: seed. Nếu bạn không nhận được thông báo lỗi, hạt giống của bạn đã chạy thành công. Để kiểm tra, chúng tôi sẽ sử dụng bảng điều khiển rails. Rails c đưa ra bảng điều khiển (tương tự như IRB). Gõ Dog.all sẽ hiển thị tất cả các con chó mà bạn đã gieo hạt nếu nó thành công.

Dog.create (tên: “Ollie”, giống: “Golden Retriever”, tuổi: 2)
Dog.create (tên: “Japhy”, giống: “Poodle”, tuổi: 1)
Dog.create (tên: “Sam” , giống: “German Shepherd”, tuổi: 5)

Bây giờ chúng ta cần quản lý các tuyến đường của mình. Các tuyến đường của chúng tôi là đầu mối liên hệ đầu tiên của chúng tôi khi đưa ra yêu cầu đối với API của chúng tôi. Để cho phép nhận yêu cầu đối với phương thức chỉ mục của chúng tôi, chúng tôi thêm mã sau vào route.rb.

Rails.application.routes.draw do
get “/ dog”, thành: “dog # index”
end

Chúng tôi cũng có thể sử dụng tài nguyên để quản lý các tuyến đường của mình. Nếu chúng tôi chỉ muốn cho phép nhận các yêu cầu đối với phương thức chỉ mục của mình, chúng tôi sẽ triển khai mã sau:

resources :mèo, only: [:index]

Cũng có thể mở tất cả các tuyến của bạn, tuy nhiên không phải lúc nào cũng được khuyến khích vì bạn có thể không muốn cho phép các yêu cầu đối với tất cả các phương thức của mình. Tuy nhiên, trong khi thử nghiệm các phương pháp bộ điều khiển của bạn, bạn cần giữ cho các tuyến của mình luôn mở. Trong trường hợp đó, bạn sẽ sử dụng mã sau:

resources :mèo

Cuối cùng, đã đến lúc tạo bộ điều khiển của chúng tôi bằng cách chạy các con chó điều khiển rails g . Bộ điều khiển là nơi logic của ứng dụng của chúng ta xảy ra. Để xem những con chó của chúng ta, chúng ta cần thêm một phương thức chỉ mục vào dog_controller.rb.

class DogsController < ApplicationController
def index
@dogs = Dog.all
render json: @dogs
end
end

Tùy thuộc vào những hành động bạn muốn API của mình thực hiện, bạn cũng có thể muốn thêm các phương thức khác tại đây, chẳng hạn như hiển thị, cập nhật, tạo và xóa. Xem chức năng đó tại đây:

def show
  @dog = Dog.find(params[:id])
  render json: @dog
enddef create
  @dog = Dog.create(
    name: params[:name],
    breed: params[:breed],
    age: params[:age])
  render json: @dog, status: :created
enddef update
  @dog = Dog.find(params[:id])
  @dog.update(
    age: params[:age]
  )
  render json: "Successfully updated"
enddef destroy
  @dog = Dog.find(params[:id])
  @dog.destroy
  render json: "Successfully deleted"
end

Cuối cùng, để xem chúng tôi có thành công hay không, chúng tôi cần khởi động máy chủ của mình bằng cách chạy rails s. Để kiểm tra các yêu cầu bài đăng của bạn (tạo, cập nhật, xóa), bạn sẽ phải kiểm tra các phương pháp của mình với Postman. Nhưng để xem những con chó của bạn chỉ cần truy cập localhost: 3000 / dog (hoặc bất kỳ cổng nào bạn đang chạy). Khi bạn nhìn thấy những chú chó của mình trong trình duyệt, viola! Bạn đã tạo một API Ruby on Rails.

Cách tạo một API

Cách tạo một API

0 0 votes
Article Rating
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments