Was ist eine REST-API?

API, eine Abkürzung für Application Program Interface, ist eine Reihe von Praktiken, Protokollen und Tools zum Erstellen von Softwareanwendungen. Manchmal benötigen wir möglicherweise die Integration eines Drittanbieters für unsere Webanwendung. Um dies zu erreichen, ist die REST-API eine einfache Sache. Der Vorteil der Rest-API besteht darin, dass sie sprachunabhängig ist.

REST (REpresentational State Transfer) ist eine einfache Architektur, die über HTTPS oder TLS läuft. Der REST-Stil betont, dass die Interaktionen zwischen Clients und Diensten durch eine begrenzte Anzahl von Vorgängen verbessert werden.

Flexibilität wird durch die Zuweisung von Ressourcen zu ihren eigenen, einzigen universellen Ressourcenindikatoren (URIs) gewährleistet. Da jede Operation (GET, POST, PUT und DELETE) eine bestimmte Bedeutung hat, vermeidet REST Unsicherheit.

Erstellen einer einfachen REST-API:

Für die API ist keine Ansicht erforderlich, da der Benutzer nicht direkt mit der Anwendung interagiert. Wir geben lediglich die Daten an, die der Dritte senden wird.

Es wird keine Ansichts- oder Bearbeitungsaktion geben, da wir hier keine Ansicht haben. Für jede Anfrage werden einige Daten mit Statuscode und Erfolgsmeldung zurückgegeben. Die Daten können im JSON- oder XML-Format vorliegen.

Anforderung: gem 'rails-api'

Erstellen Sie beim Erstellen der Anwendung als „rails-api new [application_name]“, sodass Ansichten, Assets/Stylesheets und Assets/Javascript vermieden werden.

Wir müssen unserer API einen Namensraum geben, der unseren Code sauber hält und Ihre APIs von den übrigen Controllern unabhängig hält. Wir beginnen damit, indem wir unsere Routen hinzufügen.

Routen.rb

Namespace :api do
Ressourcen:Benutzer
Ende

Es wird nach einem UsersController in app/controllers/api/users_controller.rb gesucht

Klasse api::UsersController < ApplicationController

Ende

Ich hoffe, Sie sind alle mit einfachen CRUD-Operationen vertraut. Machen Sie hier dasselbe, aber es wird keine Ansicht angezeigt. Daher müssen wir anstelle der Umleitung einige Daten mit Statuscode rendern.

Zum Beispiel.

Klasse Api::UsersController < ApplicationController

Def-Index
@users = Benutzer.all
„respond_to“ |format| ausführen
format.json { json rendern: @users }
format.xml { xml rendern: @users }
Ende
Ende

auf jeden Fall zerstören
„respond_to“ |format| ausführen
wenn @user.destroy
format.json { head :no_content, status: :Erfolgreich gelöscht }
format.xml { head :no_content, status: :Erfolgreich gelöscht }
anders
format.json { json rendern: @user.errors, Status: :Unable }
format.xml { xml rendern: @user.errors, Status: :Unable }
Ende
Ende
Ende

Ende

Auf diese Weise können wir eine REST-API erstellen.

Wenn Sie eine neue Funktion oder Änderungen an Ihrer API hinzufügen müssen, können Sie eine Version Ihrer API vornehmen.

Versionierung der API

In Routen.rb

Namespace :api do

Namespace :v1 do

Ressourcen:Benutzer
Ende
Ende

Es wird nach einem UsersController gesucht
app/controllers/api/v1/users_controller.rb

Klasse Api::V1::UsersController < ApplicationController

Ende

Stellen Sie abschließend die API-Dokumentation für die Benutzer bereit

API-Anfragen:

Benutzer auflisten

URL: http://localhost:3000/api/users
Methode: GET

Benutzer wird gelöscht

URL: http://localhost:3000/api/users/:id
Methode: DELETE

RailsCarma, ein Marken- und renommiertes globales Schienenunternehmen, das seit einem Jahrzehnt hochwertige RoR-Entwicklungsdienstleistungen anbietet. Es bietet aktualisierte und hochwertige Lösungen für alle RoR-Dienste.

Lesen Sie ähnliche Artikel:

• Eine einfache Möglichkeit, die Leistung Ihrer Rails-App zu steigern

• Die Grundlagen zum Erstellen und Verwenden von Modulen in Rails

• Echtzeit-Framework

• Implementierung von Tinymce in Ruby on Rails

Nehmen Sie Kontakt mit uns auf.