Jak utworzyć interfejs API REST dla istniejącej aplikacji Ruby on Rails 5?

Question

Mam aplikację Rails 5 z kodem ActionCable i Devise osadzonym na Heroku z użytkownikami 15K. Wielu użytkowników zasugerowało wydanie aplikacji mobilnej na stronę. Chcę zacząć od stworzenia podstawowej aplikacji mobilnej na stronę.

Kiedy korzystam z wyszukiwarki Google, otrzymuję tylko przewodnik po interfejsie API. Czy istnieją jakieś samouczki lub książki lub dowolny zasób, który pokazuje, jak utworzyć interfejs API REST dla istniejącej aplikacji Rails?

Czy ktoś może doradzić, jak to zrobić? Jak uwierzytelniać użytkowników? Jak korzystać z czatu w czasie rzeczywistym? Czy powinienem użyć jakiegoś klejnotu? Uprzejmie podziel się, jak zacząć i najlepsze praktyki. Dzięki

Answer 1

Możesz użyć klejnotu grape. Sprawdź jego Rails integration section.

Skoro masz już kilka tras w miejscu, po prostu odebrać nieużywaną ścieżkę główną dla czynnych i zamontować go tam:

mount Twitter::API => '/api' 

Answer 2

Czy są jakieś tutoriale lub książek lub dowolnych zasobów, które pokazują, w jaki sposób utworzyć API REST dla istniejącej aplikacji Rails?

Tak. Ta jest bardzo pomocna. Omówił, jak skonfigurować podstawowe części restrykcyjnego API dla już działającej (aczkolwiek bardzo prostej) aplikacji Rails.

To kilka lat, ale nadal powinien pracować dla Rails 5.

Answer 3

polecam Ci zacząć szukać odpowiedzi JSON w Rails masz wszystko, czego potrzeba do tworzenia aplikacji WWW i API z tych samych kontrolerów. Musisz zacząć od "response_to" dla JSON. Aby zacząć grać, użyj scaffold do generowania kontrolera, a dostarczysz odpowiedź dla JSON i HTML.

Answer 4

Może można użyć activemodel serializers gem, jest to część szyn 5. Jeśli nie są obecnie pomocą szyn 5 Tryb API, można dodać activemodel serializers gem do Gemfile.

może być to tutorial pomoże

Answer 5

dla Ruby on Rails 5 można wygenerować aplikację API używając:

$ rails new my_api --api

Można także zmienić istniejący program i uczynić go API jeden, z kilkoma drobnymi zmianami w niektórych plikach.

W przypadku zwykłej zwykłej aplikacji Rails wystarczy dodać respond_to dla JSON w aktualnym kontrolerze. Ex:

def index 
    @tasks = Task.all 
    respond_to :html, :json 
end 

Do uwierzytelnienia użytkownika można sprawdzić Devise gem

Answer 6

myślę pierwszym uruchomieniu z uwierzytelnianiem API. Ten klejnot może odpowiadać Twoim potrzebom: https://github.com/lynndylanhurley/devise_token_auth

Answer 7

Ponieważ chcesz zintegrować API RESTful z istniejącą aplikacją Rails, powinieneś zapoznać się z this guide.

Jest to bardziej przyjazny dla użytkownika przewodnik na temat integracji Grape (jak wspomniał Nic Nilov) z aplikacją Rails 5. Ten przewodnik zakłada, że ​​masz już istniejącą aplikację Rails.

Mam nadzieję, że to pomoże!