{"id":6517,"date":"2015-07-16T00:12:31","date_gmt":"2015-07-16T00:12:31","guid":{"rendered":"https:\/\/dev.railscarma.com\/what-is-rest-api\/"},"modified":"2020-10-16T20:46:57","modified_gmt":"2020-10-16T20:46:57","slug":"was-ist-rest-api","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/de\/blog\/fachartikel\/was-ist-rest-api\/","title":{"rendered":"Was ist eine REST-API?"},"content":{"rendered":"

API, eine Abk\u00fcrzung f\u00fcr Application Program Interface, ist eine Reihe von Praktiken, Protokollen und Tools zum Erstellen von Softwareanwendungen. Manchmal ben\u00f6tigen wir m\u00f6glicherweise die Integration eines Drittanbieters f\u00fcr unsere Webanwendung. Um dies zu erreichen, ist die REST-API eine einfache Sache. Der Vorteil der Rest-API besteht darin, dass sie sprachunabh\u00e4ngig ist.<\/p>\n

REST (REpresentational State Transfer) ist eine einfache Architektur, die \u00fcber HTTPS oder TLS l\u00e4uft. Der REST-Stil betont, dass die Interaktionen zwischen Clients und Diensten durch eine begrenzte Anzahl von Vorg\u00e4ngen verbessert werden.<\/p>\n

Flexibilit\u00e4t wird durch die Zuweisung von Ressourcen zu ihren eigenen, einzigen universellen Ressourcenindikatoren (URIs) gew\u00e4hrleistet. Da jede Operation (GET, POST, PUT und DELETE) eine bestimmte Bedeutung hat, vermeidet REST Unsicherheit.<\/p>\n

Erstellen einer einfachen REST-API:<\/h3>\n

F\u00fcr 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.<\/p>\n

Es wird keine Ansichts- oder Bearbeitungsaktion geben, da wir hier keine Ansicht haben. F\u00fcr jede Anfrage werden einige Daten mit Statuscode und Erfolgsmeldung zur\u00fcckgegeben. Die Daten k\u00f6nnen im JSON- oder XML-Format vorliegen.<\/p>\n

Anforderung: gem 'rails-api'<\/p>\n

Erstellen Sie beim Erstellen der Anwendung als \u201erails-api new [application_name]\u201c, sodass Ansichten, Assets\/Stylesheets und Assets\/Javascript vermieden werden.<\/p>\n

Wir m\u00fcssen unserer API einen Namensraum geben, der unseren Code sauber h\u00e4lt und Ihre APIs von den \u00fcbrigen Controllern unabh\u00e4ngig h\u00e4lt. Wir beginnen damit, indem wir unsere Routen hinzuf\u00fcgen.<\/p>\n

Routen.rb<\/p>\n

Namespace :api do
\nRessourcen:Benutzer
\nEnde<\/p><\/blockquote>\n

Es wird nach einem UsersController in app\/controllers\/api\/users_controller.rb gesucht<\/p>\n

Klasse api::UsersController < ApplicationController<\/p>\n

Ende<\/p>\n

Ich hoffe, Sie sind alle mit einfachen CRUD-Operationen vertraut. Machen Sie hier dasselbe, aber es wird keine Ansicht angezeigt. Daher m\u00fcssen wir anstelle der Umleitung einige Daten mit Statuscode rendern.<\/p>\n

Zum Beispiel.<\/strong><\/p>\n

Klasse Api::UsersController < ApplicationController<\/p>\n

Def-Index
\n@users = Benutzer.all
\n\u201erespond_to\u201c |format| ausf\u00fchren
\nformat.json { json rendern: @users }
\nformat.xml { xml rendern: @users }
\nEnde
\nEnde<\/p>\n

auf jeden Fall zerst\u00f6ren
\n\u201erespond_to\u201c |format| ausf\u00fchren
\nwenn @user.destroy
\nformat.json { head :no_content, status: :Erfolgreich gel\u00f6scht }
\nformat.xml { head :no_content, status: :Erfolgreich gel\u00f6scht }
\nanders
\nformat.json { json rendern: @user.errors, Status: :Unable }
\nformat.xml { xml rendern: @user.errors, Status: :Unable }
\nEnde
\nEnde
\nEnde<\/p>\n

Ende<\/p><\/blockquote>\n

Auf diese Weise k\u00f6nnen wir eine REST-API erstellen.<\/p>\n

Wenn Sie eine neue Funktion oder \u00c4nderungen an Ihrer API hinzuf\u00fcgen m\u00fcssen, k\u00f6nnen Sie eine Version Ihrer API vornehmen.<\/p>\n

Versionierung der API<\/strong><\/p>\n

In Routen.rb<\/p>\n

Namespace :api do<\/p>\n

Namespace :v1 do<\/p>\n

Ressourcen:Benutzer
\nEnde
\nEnde<\/p><\/blockquote>\n

Es wird nach einem UsersController gesucht
\napp\/controllers\/api\/v1\/users_controller.rb<\/p>\n

Klasse Api::V1::UsersController < ApplicationController<\/p>\n

Ende<\/p>\n

Stellen Sie abschlie\u00dfend die API-Dokumentation f\u00fcr die Benutzer bereit<\/p>\n

API-Anfragen:<\/p>\n

Benutzer auflisten<\/p>\n

URL: http:\/\/localhost:3000\/api\/users
\nMethode: GET<\/p><\/blockquote>\n

Benutzer wird gel\u00f6scht<\/p>\n

URL: http:\/\/localhost:3000\/api\/users\/:id
\nMethode: DELETE<\/p><\/blockquote>\n

RailsCarma, ein Marken- und renommiertes globales Schienenunternehmen, das seit einem Jahrzehnt hochwertige RoR-Entwicklungsdienstleistungen anbietet. Es bietet aktualisierte und hochwertige L\u00f6sungen f\u00fcr alle RoR-Dienste.<\/p>\n

Lesen Sie \u00e4hnliche Artikel:<\/p>\n