Phiên bản API thanh lịch trong Rails

Question

Hiện tại tôi đang triển khai phiên bản cho API REST của mình trong ứng dụng Rails của chúng tôi. Có cách nào có thể được triển khai để bạn chỉ xác định chức năng mới trong các phiên bản mới không? Ví dụ:

Tôi có bộ điều khiển Người dùng và bộ điều khiển Sản phẩm. Sản phẩm vẫn giữ nguyên giữa V1 và V2 nhưng Người dùng đã thay đổi. Sẽ tốt hơn nếu chúng tôi có thể thiết lập để nếu tôi gọi V2 Sản phẩm, ứng dụng của tôi biết nó không tồn tại và chỉ sử dụng phiên bản bộ điều khiển mới nhất thay thế (trong trường hợp này là V1). Điều này sẽ cho phép chúng ta không tạo ra một bộ điều khiển hoàn toàn mới cho mọi phiên bản; chúng tôi chỉ tạo bộ điều khiển mới cho chức năng cụ thể đã thay đổi.

Dưới đây là đoạn trích từ Routes.rb của chúng tôi và tôi thừa nhận rằng tôi không biết cách giải quyết vấn đề này. Mọi sự trợ giúp sẽ rất được trân trọng!

namespace :api do 
    scope module: :v1, constraints: ApiConstraints.new(version: 1) do 
     resources :users 
     resources :products 
    end 
    scope module: :v2, constraints: ApiConstraints.new(version: 2) do 
     resources :users 
    end 
end 

Answer 1

Bạn đã xem Grape chưa?

Những gì tôi đã thực hiện qua API mà tôi đã tạo là khi có thay đổi cho tất cả chúng (như xác thực), tôi chỉ nhận được tất cả chúng kế thừa từ bộ điều khiển api được phiên bản cụ thể, như trong Api::V1::BaseController và đặt hành vi chung điều khiển trong đó.

Kể từ khi thay đổi API thường cũng có nghĩa là thay đổi cơ quan đại diện, sử dụng một công cụ mà tạo ra các cơ quan đại diện cho bạn cũng là thực sự quan trọng, có nhiều đá quý trên mạng cho điều này như:

• RABL
• Roar
• Jbuilder

Answer 2

Đây là những gì Grape được thiết kế để làm. Ngoài ra, bạn có tùy chọn gắn API trong tệp routes.rb hoặc ánh xạ nó trong config.ru, bỏ qua ngăn xếp Rails và cải thiện đáng kể hiệu suất của API.

Answer 3

Tôi đã sử dụng cùng một chiến lược cho đôi khi và gần đây đã thay đổi phương pháp tiếp cận và thừa nhận rằng tôi bị thiên vị vì tôi cũng là một trong những tác giả của phương pháp tiếp cận mới với VersionCake.

Cách tiếp cận này chỉ là phiên bản tải trọng hoặc lượt xem của chúng tôi, quan điểm sau là hợp đồng giữa khách hàng và nếu có thay đổi hợp đồng vi phạm thì phiên bản cần phải thay đổi. Trong VersionCake, bạn có thể phiên bản quan điểm của bạn như sau:

app/views/products/show.v1.rabl 
app/views/products/show.v2.rabl 
app/views/users/show.v1.rabl 

Tính năng đặc biệt đó là quan trọng dựa trên câu hỏi của bạn là VersionCake sẽ làm suy thoái gracefully lên phiên bản hỗ trợ mới nhất. Với ví dụ trên, khách hàng yêu cầu users/1.json cho phiên bản 2 sẽ nhận được trọng tải cho users/show.v1.rabl.

Tất cả điều này được nói, nó sẽ yêu cầu áp dụng một cách tiếp cận phiên bản mới, vì vậy nó có thể không phải là câu trả lời tốt nhất, nhưng tôi nghĩ rằng đó là một lựa chọn đáng xem xét.