RESTful-Webservices erstellen

Erstellen Sie RESTful-Webservices mit den Seiten "Module", "Templates" und "Handler".

Um einen RESTful-Webservice zu erstellen, müssen Sie:

  • Ressourcenmodule definieren

  • Ressourcenvorlage definieren

  • Definieren Sie mindestens einen Ressourcen-Handler, wie GET, PUT, POST oder DELETE. Definieren Sie optional Parameter, die Sie an den Resource Handler übergeben müssen.

Die folgenden Abschnitte enthalten Informationen zum Erstellen von Ressourcenmodulen, Ressourcenvorlagen und Ressourcen-Handlern.

Siehe auch:

Übergeordnetes Thema: REST-Seiten

Ressourcenmodule verwalten

Auf der Seite "Module" können Sie Ressourcenmodule definieren, bearbeiten und löschen.

Um zur Seite "Module" zu navigieren, klicken Sie auf der Seite "REST-Überblick" unter "Objekte" auf Module, oder wählen Sie im Menü im Header die Option Module aus.

Die in der Kartenansicht standardmäßig angezeigten Modulattribute werden in der folgenden Abbildung dargestellt.

Beschreibung von module_card.png folgt
Beschreibung der Abbildung module_card.png

Der Modulstatus kann veröffentlicht oder nicht veröffentlicht werden. Wenn der Status "Nicht veröffentlicht" lautet, wird das Symbol rot angezeigt.

Klicken Sie in der Kartenansicht auf den Modulnamen, um zur Seite "Vorlagen" für dieses Modul zu gelangen. Sie können auch über das Kontextmenü zur Seite "Vorlagen" navigieren.

Folgende Aktionen sind im Kontextmenü verfügbar:

Siehe auch:

Informationen zur REST-Suchsymbolleiste

Übergeordnetes Thema: RESTful-Webservices erstellen

Ressourcenmodul erstellen

In diesem Abschnitt wird beschrieben, wie Sie ein Ressourcenmodul erstellen.

  1. Klicken Sie auf der Seite "Module" auf Modul erstellen.
  2. Geben Sie die folgenden Felder ein. Die Felder mit einem Sternchen (*) sind Pflichtfelder:

    Registerkarte "Module Definition"

    • Modulname: Geben Sie den Namen des Moduls ein. In diesem Feld ist die Groß- und Kleinschreibung zu beachten.

    • Basispfad: Geben Sie die Basis der URI für den Zugriff auf den RESTful-Service ein. Beispiel: hr/ bedeutet, dass alle URIs, die mit hr/ beginnen, von diesem Ressourcenmodul bearbeitet werden. Beachten Sie die Änderung in der Vorschau-URL, wenn Sie den Basispfad eingeben.

    • Veröffentlicht: Aktivieren Sie diese Option, um den RESTful Service zur Verwendung verfügbar zu machen.

    • Paginierungsgröße: Geben Sie die Anzahl der Ergebnisse ein, die auf jeder Seite basierend auf einer Datenbankabfrage zurückgegeben werden sollen, oder wählen Sie sie aus. Der Standardwert ist 25.

    • Geschützt durch Berechtigung: Wählen Sie eine Berechtigung aus, um das Modul aus der Dropdown-Liste zu schützen.

    • Bemerkungen: Geben Sie beschreibende Bemerkungen ein.

    • Gehe nach der Erstellung zu Modul: Wählen Sie diese Option aus, um zur Seite "Vorlagen" zu wechseln, nachdem das Modul erstellt wurde.

    Registerkarte "Ursprünge zulässig"

    • Geben Sie Ursprünge ein, die auf die Ressourcenvorlagen zugreifen dürfen. Klicken Sie auf Hinzufügen (+), um jeden Ursprung hinzuzufügen. Beispiel:

      http://example1.org

      https://*.example2.com

    Code anzeigen: Wählen Sie diese Option aus, um das PL/SQL-Codeäquivalent des Schiebereglers "Modul erstellen" anzuzeigen. Sie können diesen PL/SQL-Code in das Arbeitsblatt kopieren und ausführen, um dieselbe Aktion auszuführen, die ausgeführt wird, wenn Sie im Schieberegler "Modul erstellen" auf Erstellen klicken.

  3. Klicken Sie auf Create.

    Das neue Modul wird auf der Seite "Module" angezeigt. Wenn Sie es nicht sehen können, suchen Sie das Modul mit dem Suchfeld.

Übergeordnetes Thema: Ressourcenmodule verwalten

Ressourcenmodule importieren

In diesem Abschnitt wird beschrieben, wie Sie ein Ressourcenmodul importieren.

Hinweis:

Sie können ein OpenAPI-Dokument der Version 2.0 oder 3.0 nur im JSON-Format importieren.
  1. Klicken Sie auf der Seite "Module" oben rechts auf Modul importieren.
  2. Durchsuchen Sie die zu importierende JSON-Datei, und wählen Sie sie aus. Klicken Sie auf Öffnen.

    Der Schieberegler "Importmodul" wird angezeigt, wenn die Felder Basispfad und Vorschau-URL ausgefüllt sind. Bearbeiten Sie den Basispfad nach Bedarf. Wenn Sie das Basispfadfeld bearbeiten, wird auch der Basispfad im JSON-Format aktualisiert, das im Schieberegler angezeigt wird.

  3. Klicken Sie auf Importieren.

    Wenn das Modul importiert wird, wird eine Berechtigungskonfiguration erstellt und zum Schutz des Moduls festgelegt. Der Name der Berechtigung wird generiert, indem der Basispfad verwendet wird und "_priv" am Ende der Basispfadzeichenfolge hinzugefügt wird. Außerdem wird jeder Schrägstrich "/" im Basispfad durch einen Unterstrich "_" ersetzt.

  4. Ihr Modul ist zur Bearbeitung bereit.

    Nachdem das Modul importiert wurde, werden die Vorlagen und Handler erstellt, das Modul wird jedoch nicht veröffentlicht. Sie müssen SQL- und PL/SQL-Blöcke für jeden Handler bereitstellen und das Modul veröffentlichen, wenn es zum Testen oder zur Produktion bereit ist.

Übergeordnetes Thema: Ressourcenmodule verwalten

Ressourcenmodul bearbeiten

In diesem Abschnitt wird beschrieben, wie Sie ein Ressourcenmodul bearbeiten.

  1. Klicken Sie auf der Seite "Module" für das jeweilige Modul auf Kontextmenüsymbol, und wählen Sie Bearbeiten aus.
  2. Bearbeiten Sie die Pflichtfelder, und klicken Sie auf Speichern. Eine Beschreibung der Felder finden Sie unter Ressourcenmodul erstellen.

Übergeordnetes Thema: Ressourcenmodule verwalten

Ressourcenmodul löschen

In diesem Abschnitt wird beschrieben, wie Sie ein Ressourcenmodul löschen.

  1. Klicken Sie auf der Seite "Module" für das jeweilige Modul auf Kontextmenü, und wählen Sie Löschen aus.

    Daraufhin wird eine Eingabeaufforderung angezeigt, in der Sie zur Bestätigung aufgefordert werden.

  2. Klicken Sie auf OK, um den Löschvorgang auszuführen.

Übergeordnetes Thema: Ressourcenmodule verwalten

Ressourcenmodul veröffentlichen/Veröffentlichung aufheben

In diesem Abschnitt wird beschrieben, wie Sie ein Ressourcenmodul verfügbar machen.

  1. Klicken Sie auf der Seite "Module" für das jeweilige Modul auf Kontextmenü, und wählen Sie Veröffentlichen oder Veröffentlichung aufheben aus.

    Es wird eine Eingabeaufforderung zur Bestätigung angezeigt.

  2. Klicken Sie auf OK.

Übergeordnetes Thema: Ressourcenmodule verwalten

Ressourcenmodule exportieren

Sie können den PL/SQL-Quellcode für die API oder den JSON-Code der offenen API (Swagger) für ein Ressourcenmodul oder einen RESTful-Service exportieren. Wenn das Modul Vorlagen, Handler, Parameter, Rollen usw. enthält, werden diese Objekte ebenfalls angezeigt und exportiert.

  1. Klicken Sie auf der Seite "Module" für ein bestimmtes Modul auf Kontextmenü, und wählen Sie Modul exportieren aus.
  2. Wählen Sie PL/SQL aus, um die PL/SQL-Quelle für die API zu kopieren oder zu exportieren. Wählen Sie OpenAPI aus, um den JSON-Code der offenen API (Swagger) für das Modul zu kopieren oder zu exportieren.

    Hinweis:

    Ein mit der offenen API exportiertes Modul wird immer mit dem Status "Nicht veröffentlicht" importiert.
  3. Klicken Sie auf In Zwischenablage kopieren, um den Code zu kopieren, oder klicken Sie auf Herunterladen, um ihn auf den lokalen Computer herunterzuladen.

Übergeordnetes Thema: Ressourcenmodule verwalten

Modul in der OpenAPI-Ansicht anzeigen

In diesem Abschnitt wird beschrieben, wie Sie das Modul in der Ansicht "API öffnen" öffnen.

Die Ansichtsoption "API öffnen" ist für Module verfügbar, die veröffentlicht und nicht geschützt sind.
  1. Klicken Sie auf der Seite "Module" für das jeweilige Modul auf Kontextmenü, und wählen Sie OpenAPI-Ansicht aus.
  2. Das Modul wird als Swagger-UI-Implementierung angezeigt.
    Sie können die Handler anzeigen und ausführen, Parameter an die Handler übergeben und die Antworten kopieren oder herunterladen.

    Weitere Informationen zur Implementierung der Swagger-UI finden Sie auf der offiziellen Website der Swagger-UI.

Übergeordnetes Thema: Ressourcenmodule verwalten

Ressourcenvorlagen verwalten

Auf der Seite "Vorlagen" können Sie Ressourcenvorlagen für ein Modul definieren, bearbeiten und löschen.

Um zu dieser Seite zu navigieren, klicken Sie auf der Seite "Module" auf Kontextmenü für ein Modul, und wählen Sie Vorlagen aus, oder klicken Sie auf den Namen des Moduls in der Kartenansicht.

Oben auf der Seite ist die Modulkarte mit Kontextmenüoptionen wie Bearbeiten, Löschen, Veröffentlichen und Exportieren verfügbar.

Die Vorlagenattribute, die standardmäßig in der Kartenansicht angezeigt werden, werden in der folgenden Abbildung dargestellt.

Beschreibung von template_card.png folgt
Beschreibung der Abbildung template_card.png

Klicken Sie in der Kartenansicht auf den Vorlagennamen, um zur Seite "Handler" zu gelangen. Sie können auch über das Kontextmenü zur Seite "Handler" navigieren.

Folgende Aktionen sind im Kontextmenü verfügbar:

Übergeordnetes Thema: RESTful-Webservices erstellen

Ressourcenvorlagen erstellen

In diesem Abschnitt wird beschrieben, wie Sie eine Ressourcenvorlage erstellen.

  1. Klicken Sie auf der Seite "Vorlagen" für ein Modul auf Vorlage erstellen.
  2. Geben Sie die folgenden Felder ein. Die Felder mit einem Sternchen (*) geben an, dass sie obligatorisch sind:

    • URI-Vorlage: Geben Sie das URI-Muster für die Ressourcenvorlage ein.

      Beispiel: Das Muster /objects/:object/:id? stimmt mit /objects/emp/101 überein (entspricht einer Anforderung für das Element in der emp-Ressource mit der ID 101) und stimmt auch mit /objects/emp/ überein (entspricht einer Anforderung für die emp-Ressource, da der Parameter :id mit dem Modifizierer ? annotiert wird. Dies gibt an, dass der id-Parameter optional ist).

      Beachten Sie, dass die Vorschau-URL beim Eingeben der URI-Vorlage geändert wird.

    • Priorität: Geben Sie die Priorität für die Auswertung der Ressourcenvorlage ein, oder wählen Sie sie aus (1 hat eine niedrige Priorität und 9 eine hohe Priorität).

    • HTTP-Entitytagtyp: Wählen Sie den Typ des Entitytags aus, das von der Ressourcenvorlage verwendet werden soll. Ein Entitytag ist ein HTTP-Header, der als Versions-ID für eine Ressource fungiert.

      Mögliche Optionen:

      • Sicherer HASH (Standard): Der Inhalt der zurückgegebenen Ressourcendarstellung wird mit einer sicheren Digest-Funktion gehasht, um einen eindeutigen Fingerprint für eine bestimmte Ressourcenversion bereitzustellen.

      • Abfrage: Definieren Sie eine Abfrage manuell, die eine Ressourcenversion eindeutig identifiziert. Eine manuell definierte Abfrage kann häufig ein Entitytag effizienter generieren als das Hashing der gesamten Ressourcendarstellung.

      • Keine: Generieren Sie kein Entitytag.

    • Bemerkungen: Geben Sie ggf. beschreibende Bemerkungen ein.

    • Gehe nach Erstellung zu Handlern: Wählen Sie diese Option aus, um nach der Erstellung der Vorlage zur Seite "Handler" zu wechseln.

    Code anzeigen: Wählen Sie diese Option aus, um das PL/SQL-Codeäquivalent des Schiebereglers "Vorlage erstellen" anzuzeigen. Sie können diesen PL/SQL-Code in das Arbeitsblatt kopieren und ausführen, um dieselbe Aktion auszuführen, die beim Klicken auf Erstellen im Schieberegler "Vorlage erstellen" ausgeführt wird.

  3. Klicken Sie auf Create.

    Die neue Vorlage für das Modul wird der Seite "Vorlagen" hinzugefügt.

    Wenn "Go to Handlers after creation" ausgewählt ist, können Sie den Modulnamen in den Navigationspfaden oben auf der Seite verwenden, um die Liste der Vorlagen für das Modul anzuzeigen.

Übergeordnetes Thema: Ressourcenvorlagen verwalten

Ressourcenvorlage bearbeiten

In diesem Abschnitt wird beschrieben, wie Sie eine Ressourcenvorlage bearbeiten.

  1. Klicken Sie auf der Seite "Vorlagen" für eine bestimmte Vorlage auf Kontextmenü, und wählen Sie Bearbeiten aus.
  2. Bearbeiten Sie die erforderlichen Felder, und klicken Sie auf Speichern.

    Eine Beschreibung der Felder finden Sie unter Ressourcenvorlagen erstellen.

Übergeordnetes Thema: Ressourcenvorlagen verwalten

Ressourcenvorlagen löschen

In diesem Abschnitt wird beschrieben, wie Sie eine Ressourcenvorlage löschen.

  1. Klicken Sie auf der Seite "Vorlagen" für eine bestimmte Vorlage auf Kontextmenü, und wählen Sie Löschen aus.

    Sie wurden zur Bestätigung aufgefordert.

  2. Klicken Sie auf OK, um den Löschvorgang auszuführen.

Übergeordnetes Thema: Ressourcenvorlagen verwalten

Ressourcen-Handler verwalten

Auf der Seite "Handler" können Sie Ressourcen-Handler für eine Vorlage erstellen, bearbeiten und löschen.

Um zu dieser Seite zu navigieren, klicken Sie auf der Seite "Vorlagen" auf Kontextmenü für eine Vorlage, und wählen Sie Handler aus. Sie können auch auf den Namen der Vorlage in der Kartenansicht klicken.

Oben auf der Seite ist die Vorlagenkarte mit Kontextmenüoptionen wie "Bearbeiten" und "Löschen" verfügbar.

Die in der Kartenansicht standardmäßig angezeigten Handlerattribute werden in der folgenden Abbildung dargestellt.

Beschreibung von handler_card.png folgt
Beschreibung der Abbildung handler_card.png

Die HTTP-Methode kann eine der folgenden Methoden sein: GET, PUT, POST und DELETE.

Sie können über das Kontextmenü zur Seite "HTTP-Methode" navigieren. Auf der Seite "HTTP-Methode" werden drei Registerkarten angezeigt: Quelle, Parameter und vorab authentifizierte Anforderungen.

Informationen zum Erstellen eines Ressourcen-Handlers finden Sie unter Ressourcen-Handler erstellen.

Hinweis:

Diese Option ist nicht verfügbar, wenn für die Vorlage alle vier Handler erstellt wurden (GET, POST, PUT, DELETE).

Folgende Aktionen sind im Kontextmenü verfügbar:

Übergeordnetes Thema: RESTful-Webservices erstellen

Ressourcen-Handler erstellen

In diesem Abschnitt wird beschrieben, wie Sie einen Ressourcen-Handler erstellen.

  1. Klicken Sie auf der Seite "Handler" auf Handler erstellen.
  2. Geben Sie die Eigenschaften des Resource Handlers an. Die spezifischen Optionen hängen vom Methodentyp ab.

    Registerkarte "Handler-Definition"

    • Methode: Geben Sie die HTTP-Anforderungsmethode für diesen Handler ein: GET (ruft eine Darstellung einer Ressource ab), POST (erstellt eine neue Ressource oder fügt eine Ressource zu einer Collection hinzu), PUT (aktualisiert eine vorhandene Ressource) oder DELETE (löscht eine vorhandene Ressource). Es ist nur ein Handler für jede HTTP-Methode zulässig.

    • Elemente pro Seite: Geben Sie die Standard-Paginierungsgröße oder die Anzahl der Zeilen ein, die für eine Datenbankabfrage zurückgegeben werden sollen, oder wählen Sie sie aus. Diese Option ist nur für GET-Handler verfügbar. Wenn dieser Wert nicht definiert ist, entspricht die Anzahl der Elemente pro Seite der im Modul definierten Anzahl.

    • Quelltyp: Wählen Sie die Quellimplementierung für die ausgewählte HTTP-Methode aus. Der Standardwert ist die Collection-Abfrage.

      • Sammlungsabfrage: Führt eine SQL-Abfrage aus und transformiert das Ergebnisset in eine JSON-Darstellung. Verfügbar, wenn die HTTP-Methode GET ist.

      • Collection-Element: Führt eine SQL-Abfrage aus, die eine Datenzeile in eine JSON-Darstellung zurückgibt. Verfügbar, wenn die HTTP-Methode GET ist.

      • Medien: Führt eine SQL-Abfrage aus, die einem bestimmten Format entspricht, und verwandelt das Ergebnisset in eine binäre Darstellung mit einem zugehörigen HTTP-Content-Type-Header, der den Internetmedientyp der Darstellung identifiziert.

      • PL/SQL: Führt einen anonymen PL/SQL-Block aus und wandelt beliebige OUT- oder IN/OUT-Parameter IN eine JSON-Darstellung um.

    • Quelle: Geben Sie die SQL-Abfrage oder den PL/SQL-Block für die HTTP-Methode ein. Auf der Seite mit den Handler-Details können Sie den SQL- oder PL/SQL-Handler-Code im Handler Editor testen.

    • Gehe nach Erstellung zu Handler: Wählen Sie diese Option aus, um zur Detailseite zu gehen, nachdem der Handler erstellt wurde.

    Registerkarte "Zulässige MIMEs"

    Gibt den Typ der Informationen an, die im HTTP-Anforderungsbody enthalten sind. Beispiel: Wenn der POST-Handler JSON in der Anforderung erwartet, fügen Sie "Application/JSON" als MIME-Typ hinzu.

    Code anzeigen: Wählen Sie diese Option aus, um das PL/SQL-Codeäquivalent des Schiebereglers "Handler erstellen" anzuzeigen. Sie können diesen PL/SQL-Code in das Arbeitsblatt kopieren und ausführen, um dieselbe Aktion auszuführen, die beim Klicken auf Erstellen im Schieberegler "Handler erstellen" ausgeführt wird.

  3. Klicken Sie auf Create.

    Der Handler wird auf der Seite "Handler" für das jeweilige Template angezeigt.

    Sie können den REST-Serviceendpunkt mit einem REST-Client oder einem Befehlszeilentool wie cURL testen.

Siehe auch:

Informationen zu cURL und zum Testen von RESTful Services im Oracle REST Data Services Developer's Guide.

Übergeordnetes Thema: Ressourcen-Handler verwalten

Ressourcen-Handler bearbeiten

In diesem Abschnitt wird beschrieben, wie Sie einen Ressourcen-Handler bearbeiten.

  1. Klicken Sie auf der Seite "Handler" für einen bestimmten Handler auf Kontextmenü und dann auf Details.
  2. Bearbeiten Sie die erforderlichen Felder, und klicken Sie auf Speichern.

    Eine Beschreibung der Felder finden Sie unter Ressourcen-Handler erstellen.

Übergeordnetes Thema: Ressourcen-Handler verwalten

Ressourcen-Handler löschen

In diesem Abschnitt wird beschrieben, wie Sie einen Resource Handler löschen.

  1. Klicken Sie auf der Seite "Handler" für den jeweiligen Handler auf Kontextmenü und dann auf Löschen.

    Zur Bestätigung werden Sie aufgefordert.

  2. Klicken Sie auf OK, um den Löschvorgang auszuführen.

Übergeordnetes Thema: Ressourcen-Handler verwalten

Ressourcen-Handler-Details anzeigen und Parameter verwalten

Sie können Ressourcen-Handler-Details anzeigen und Parameter auf der Seite HTTP-Methode verwalten.

Um zu dieser Seite zu navigieren, klicken Sie für einen bestimmten Handler auf Kontextmenü, und wählen Sie Details aus, oder klicken Sie auf den Namen des Handlers in der Kartenansicht.

Oben auf der Seite ist die Handlerkarte mit Kontextmenüoptionen wie Bearbeiten und Löschen verfügbar.

Die Seite HTTP-Methode des Handlers enthält zwei Hauptabschnitte:

  • Ein Codeeditor zur Ausführung des SQL- oder PL/SQL-Quellcodes, der im Resource Handler definiert wurde. Sie können den Code ausführen, speichern, rückgängig machen, wiederholen, herunterladen und die Ausgabe löschen. Weitere Informationen zum Editor finden Sie unter SQL-Anweisungen im Codeeditor ausführen.

    Implizite Parameter, die in REST-Service-Handlern verwendet werden, werden in einer Bildlaufliste rechts neben dem Editor angezeigt. Siehe Implizite Parameter

  • Ein Abschnitt zum Verwalten von Parametern, die für die Ausführung der HTTP-Methode erforderlich sind.

Standardmäßig werden die Parameter in der Rasteransicht angezeigt. Die Attribute, die in einem Parameter in der Kartenansicht angezeigt werden, werden in der folgenden Abbildung dargestellt.

Eine Beschreibung von parameter_card.png folgt
Beschreibung der Abbildung parameter_card.png

Folgende Aktionen sind im Kontextmenü verfügbar:

  • Parameter erstellen
    In diesem Abschnitt wird beschrieben, wie Sie einen Parameter für einen Resource Handler erstellen.
  • Parameter bearbeiten
    In diesem Abschnitt wird beschrieben, wie Sie einen Parameter bearbeiten.
  • Parameter löschen
    In diesem Abschnitt wird beschrieben, wie Sie einen Parameter löschen.
  • Implizite Parameter
    In diesem Abschnitt werden die impliziten Parameter auf der Seite "Ressourcen-Handler-Details" beschrieben. Diese Parameter werden den Resource Handlern automatisch hinzugefügt.

Siehe auch:

Informationen zur REST-Suchsymbolleiste

Übergeordnetes Thema: Ressourcen-Handler verwalten

Parameter wird erstellt

In diesem Abschnitt wird beschrieben, wie Sie einen Parameter für einen Resource Handler erstellen.

  1. Klicken Sie auf der Seite HTTP-Methode des Handlers auf Parameter erstellen.
  2. Geben Sie die folgenden Felder ein. Die Felder mit einem Sternchen (*) sind Pflichtfelder:

    • Parametername: Geben Sie den Namen des Parameters ein, wie er in der URI-Vorlage oder im HTTP-Header benannt ist. Der Name definiert, wie der Parameter in der eingehenden Anforderung identifiziert wird oder wie der Parameter in der Antwort benannt wird.

    • Bind-Variablenname: Geben Sie den Namen des Parameters ein, wie er in SQL referenziert wird. Wenn NULL angegeben ist, ist der Parameter ungebunden.

    • Quelltyp: Wählen Sie den Typ aus, der angegeben wird, wenn der Parameter aus der URI-Vorlage oder dem HTTP-Header stammt.

    • Parametertyp: Wählen Sie den nativen Typ des Parameters aus.

    • Zugriffsmethode: Wählen Sie die Parameterzugriffsmethode aus. Gibt an, ob der Parameter ein Eingabewert, Ausgabewert oder beides ist.

    Code anzeigen: Wählen Sie diese Option aus, um das PL/SQL-Codeäquivalent des Schiebereglers "Parameter erstellen" anzuzeigen. Sie können diesen PL/SQL-Code in das Arbeitsblatt kopieren und ausführen, um dieselbe Aktion auszuführen, die ausgeführt wird, wenn Sie im Schieberegler "Parameter erstellen" auf Erstellen klicken.

  3. Klicken Sie auf Create.

    Der Parameter wird im Abschnitt "Parameter" hinzugefügt.

Parameter bearbeiten

In diesem Abschnitt wird beschrieben, wie Sie einen Parameter bearbeiten.

  1. Klicken Sie im Abschnitt "Parameter" für den spezifischen Parameter auf Kontextmenü, und wählen Sie Bearbeiten aus.
  2. Bearbeiten Sie die erforderlichen Felder, und klicken Sie auf Speichern.

    Eine Beschreibung der Felder finden Sie unter Parameter erstellen.

Parameter löschen

In diesem Abschnitt wird beschrieben, wie Sie einen Parameter löschen.

  1. Klicken Sie im Abschnitt "Parameter" für den spezifischen Parameter auf Kontextmenü, und wählen Sie Löschen aus.

    Sie wurden zur Bestätigung aufgefordert.

  2. Klicken Sie auf Ja, um diese zu löschen.
Implizite Parameter

In diesem Abschnitt werden die impliziten Parameter auf der Seite "Ressourcen-Handler-Details" beschrieben. Diese Parameter werden den Resource Handlern automatisch hinzugefügt.

Tabelle 4-1: Implizite Parameter

Name Typ Zugriffsmodus HTTP-Header Beschreibung

:body

BLOB

IN

N/V

Gibt den Text der Anforderung als temporäres BLOB an.

:body_text

CLOB

IN

N/V

Gibt den Text der Anforderung als temporäres CLOB an.

:content_type

VARCHAR

IN

Content-Type

Gibt den MIME-Typ des Anforderungstextes an, wie im Content-Type-Anforderungsheader angegeben.

:current_user

VARCHAR

IN

N/V

Gibt den authentifizierten Benutzer für die Anforderung an. Wenn kein Benutzer authentifiziert ist, wird der Wert auf Null gesetzt.

:forward_location

VARCHAR

OUT

X-ORDS-FORWARD-LOCATION

Gibt den Speicherort an, an den Oracle REST Data Services eine GET-Anforderung weiterleiten muss, um die Antwort für diese Anforderung zu erstellen.

:fetch_offset

NUMBER

IN

N/V

Gibt den nullbasierten Offset der ersten Zeile an, die auf einer Seite angezeigt werden soll.

:fetch_size

NUMBER

IN

N/V

Gibt die maximale Anzahl von Zeilen an, die auf einer Seite abgerufen werden sollen.

:page_offset

NUMBER

IN

N/V

Gibt den auf Null basierenden Seitenoffset in einer paginierten Anforderung an.

Hinweis: Der Parameter The :page_offset ist veraltet. Verwenden Sie stattdessen den Parameter :row_offset.

:page_size

NUMBER

IN

N/V

Gibt die maximale Anzahl von Zeilen an, die auf einer Seite abgerufen werden sollen.

Der Parameter :page_size ist veraltet. Verwenden Sie stattdessen :fetch_size parameter .

:row_offset

NUMBER

IN

N/V

Gibt den einbasierten Index der ersten Zeile an, die in einer paginierten Anforderung angezeigt werden soll.

:row_count

NUMBER

IN

N/V

Gibt den einbasierten Index der letzten Zeile an, die in einer paginierten Anforderung angezeigt werden soll.

:status_code

NUMBER

OUT

X-ORDS-STATUS-CODE

Gibt den HTTP-Statuscode für die Anforderung an.

Weitere Informationen zu den impliziten Parametern finden Sie in der Dokumentation Oracle REST Data Services Developer's Guide.

Vorab authentifizierte Anforderungen für den Zugriff auf ORDS RESTful Services verwenden

Um auf geschützte RESTful-Services zuzugreifen, können Sie vorab authentifizierte Anforderungen erstellen und entziehen.

Mit vorab authentifizierten Anforderungen können Sie ohne Benutzerzugangsdaten auf geschützte ORDS RESTful-Services zugreifen. Wenn Sie die vorab authentifizierte Anforderung erstellen, wird eine eindeutige URL generiert. Sie können diese URL einem externen Benutzer zur Interaktion mit der bestimmten RESTful-Entity mit Standard-HTTP-Tools bereitstellen.

Weitere Informationen zu vorab authentifizierten Anforderungen finden Sie unter Oracle REST Data Services - Vorab authentifizierte Anforderungen im Oracle REST Data Services-Entwicklerhandbuch.

Um zur Seite "Vorab authentifizierte Anforderungen" zu navigieren, können Sie eine der folgenden Aktionen ausführen:

  • Klicken Sie auf der Überblickseite auf die Kachel Vorab authentifizierte Anforderungen.

  • Blenden Sie in der Menüleiste Sicherheit ein, und wählen Sie Vorab authentifizierte Anforderungen aus.

Themen:

Übergeordnetes Thema: Ressourcen-Handler verwalten

Vorab authentifizierte Anforderung erstellen

So erstellt man eine vorab authentifizierte Anforderung für einen vorhandenen Handler:

  1. Wählen Sie im Kontextmenü für einen vorhandenen Handler die Option Neue vorab authentifizierte Anforderung erstellen.

    Der Bereich "Vorab authentifizierte Anforderung erstellen" wird angezeigt.

  2. Geben Sie im Feld Tokenablauf die Tokenablaufdauer in Sekunden ein.

    Wählen Sie Code anzeigen aus, um den zugrunde liegenden Quellcode für die Erstellung der vorab authentifizierten Anforderung anzuzeigen.

    Klicken Sie auf Create.

    Das Token, der Alias und der relative Link für den Zugriff auf die Ressource werden angezeigt. Sie müssen das Token und den Alias verfolgen, da Sie seine Werte später nicht mehr abrufen können. Wenn Sie die Werte vergessen, können Sie das Token entziehen und erneut ein neues erstellen.

Vorab authentifizierte Anforderung anzeigen

Wählen Sie im Kontextmenü für einen vorhandenen Handler die Option Vorab authentifizierte Anforderungen und dann Details aus.

Die vorautomatisierten Anforderungen für den jeweiligen Handler werden angezeigt.

Vorab authentifizierte Anforderung entziehen

So entziehen Sie die vorab authentifizierte Anforderung für einen Handler:

  1. Wählen Sie im Kontextmenü für einen vorhandenen Handler die Option Vorab authentifizierte Anforderungen und dann Details aus.

    Die im Voraus authentifizierten Anforderungen für den jeweiligen Handler werden angezeigt.

  2. Wählen Sie im Kontextmenü für die vorab authentifizierte Anforderung die Option Entziehen.

    Sie müssen die Bestätigung bestätigen.

  3. Klicken Sie auf Bestätigen, um die Anforderung zu entziehen.

Beispiel: Datensatz mit einem POST-Handler einfügen

Das folgende Beispiel zeigt, wie Sie einen Record in die Tabelle DEPT einfügen.

Voraussetzungen

  • Erstellen Sie mit dem Arbeitsblatt auf der SQL-Seite eine DEPT-Tabelle. 

    CREATE TABLE DEPT(  
  DEPTNO     number(2,0),  
  DNAME      varchar2(14),  
  LOC        varchar2(13),  
  CONSTRAINT PK_DEPT PRIMARY KEY (DEPTNO)  
)

  • Erstellen Sie ein Modul namens example. Siehe Ressourcenmodul erstellen

  • Erstellen Sie eine Vorlage mit dem Namen emp/ für das Modul. Siehe Ressourcenvorlagen erstellen

So fügen Sie einen Datensatz ein:
  1. Klicken Sie auf der Seite "Handler" auf Handler erstellen.
  2. Geben Sie die folgenden Informationen ein:

    • Wählen Sie im Feld Methode die Option POST aus.

    • Wählen Sie im Feld Quelltyp die Option PL/SQL aus.

    • Geben Sie im Feld Quelle den folgenden PL/SQL-Block ein: 

      DECLARE  
   id number;
BEGIN
    INSERT INTO DEPT (DEPTNO, DNAME, LOC) VALUES (:DEPTNO, :DEPTNAME, :DEPTLOC) RETURNING DEPTNO INTO id;
    :status_code := 201;
    :forward_location := id;
END;

      Dabei gilt:

      • RETURNING DEPTNO INTO id gibt den Wert zurück, der DEPTNO in die Variable id zugewiesen ist.

      • :status_code ist ein impliziter Parameter, dem 201 zugewiesen ist, um anzugeben, dass die Ressource erstellt wurde.

      • :forward_location ist ein impliziter Parameter, dem die id zugewiesen ist, die den Wert DEPTNO enthält. Dieser Parameter gibt den Standort an, an den eine GET-Anforderung weitergeleitet werden soll, um die Antwort für die POST-Anforderung zu erstellen.

    • Stellen Sie sicher, dass Gehe zur Seite "Handler" nach der Erstellung ausgewählt ist.

    • Wählen Sie in der Registerkarte Zulässige MIMEs aus der Dropdown-Liste die Option application/json aus, und klicken Sie auf Hinzufügen +.

    • Klicken Sie auf Create.

    Die Seite "Handler POST" wird angezeigt.

    Sie können den Quellcode testen, indem Sie auf der Registerkarte "Quelle" auf Anweisung ausführen Anweisung ausführen klicken.

  3. Erstellen Sie einen GET-Ressourcen-Handler, um eine Antwort für die POST-Anforderung zu erstellen.

    Erstellen Sie im Beispielmodul eine Vorlage mit dem Namen emp/:id.

    Erstellen Sie einen GET-Ressourcen-Handler, dessen Quelltyp Prüfelement und Quelle die folgende Abfrage enthält: 

    SELECT * FROM DEPT WHERE DEPTNO = :id
  4. Testen Sie den RESTful-Serviceendpunkt mit dem folgenden Befehl in cURL. Sie können die URL (http://xyz.us.comp.com:1234/ords/pdbdba/example/emp) mit dem Symbol "In Zwischenablage kopieren" in der POST-Handlerkarte oben kopieren.
    curl --location --request POST --header "Content-Type: application/json" 
--data '{"DEPTNO": 54, "DEPTNAME": "HR", "DEPTLOC": "America" }' 'http://xyz.us.comp.com:1234/ords/pdbdba/example/emp/'

    Ausgabe: 

    {"deptno":54,"dname":"HR","loc":"America","links":[{"rel":"collection",
"href":"xyz.us.comp.com:1234/ords/pdbdba/example/emp/"}]}
  5. Prüfen Sie auf der SQL-Seite in der Tabelle DEPT, ob der neue Record mit der folgenden Anweisung eingefügt wurde:
    SELECT * FROM DEPT;

Übergeordnetes Thema: RESTful-Webservices erstellen