Eine benutzerdefinierte API für einen Fa${Requisitionade REST-Service implementieren

Wenn Sie eine App entwickeln, beginnen Sie in der Regel zuerst mit der Benutzeroberfläche und verbinden dann Ihre Anwendung mit einer anderen Anwendung, indem Sie REST-Webservices verwenden. Diese Vorgehensweise eignet sich für kleine oder einfache Anwendungen. Wenn Anwendungen größer sind und Sie eine Verbindung mit mehreren Backend-Services herstellen möchten, können Sie versehentlich Performance- und Sicherheitsprobleme verursachen.

Es empfiehlt sich, mit der Erstellung einer Fanade API-Ebene zwischen externen Backend-Services und der Benutzeroberfläche zu beginnen, um so zu reduzieren, dass die Anzahl der Aufrufe an die Backend-Services wenn möglich reduziert wird. Beispiel: Ihre Mobile-Anwendung kann einen einzelnen Aufruf an die Fanade API-Schicht ausführen, die die Aufrufe an andere REST-Services verarbeitet und alle eingehenden Daten in einer Antwort auf Ihre Mobile-Anwendung konsolidiert.

Vollständige benutzerdefinierte API erstellen

So erstellen Sie eine vollständige benutzerdefinierte API mit Oracle Mobile Hub.

Klicken Sie auf symbol für Seitenmenü öffnen, und wählen Sie im Seitenmenü Entwicklung, APIs aus. Wenn bereits eine API erstellt wurde (im Status "Entwurf" oder "Veröffentlicht"), wird eine Liste der APIs angezeigt. Wenn keine benutzerdefinierten APIs vorhanden sind, wird eine Seite mit der Schaltfläche Neue API angezeigt. Klicken Sie auf die bereits erstellte API oder auf Neue API, um zu beginnen.

Endpunkte definieren

Sie erstellen Ressourcen, um die Endpunkte der API zu definieren. Eine Ressource ist der Navigationspfad einer API. Mit diesem Typ sind einige Daten verknüpft, eine Beziehung zu anderen Ressourcen und enthält eine oder mehrere Methoden, die sich darauf auswirken. Eine Ressource kann nahezu jeder sein: ein Bild, eine Textdatei, eine Sammlung von anderen Ressourcen, eine logische Transaktion, eine Prozedur usw.

  1. Klicken Sie auf den Navigationslink Endpunkte , um zu beginnen.
  2. Klicken Sie auf Neue Ressource , und fügen Sie einige grundlegende Informationen hinzu.

    Immer wenn Sie auf Neue Ressource klicken, erstellen Sie eine Top-Level-(Root-) Ressource. Wenn Sie eine untergeordnete (verschachtelte) Ressource hinzufügen möchten, klicken Sie auf Hinzufügen ( + ) neben der Ressource der obersten Ebene. Klicken Sie auf X , um eine Ressource zu löschen.

    Hinweis:

    Symbole unter den Methoden-Links anzeigen ? Jedes Mal, wenn Sie eine Methode für eine Ressource definieren, wird unter dem Link Methoden ein Symbol angezeigt. Verwenden Sie diese als Shortcuts, um festzustellen, welche Methoden bereits für eine Ressource definiert wurden. Klicken Sie auf ein Symbol, um direkt zu seiner Definition auf der Seite "Methoden" zu gehen.
  3. Geben Sie den Ressourcenpfad an, bei dem es sich um den URI handelt (relativ zum Basis-URI). Beispiel: Wenn die Basis-URI /mobile/custom/audits/ ist, könnten Sie die Ressource findings, d.h. /mobile/custom/audits/findings, hinzufügen.
  4. Geben Sie den Anzeigenamen an. Dabei handelt es sich um einen Namen für die Ressource, mit dem Sie in der API-Dokumentation auf einfache Weise identifizieren können.
    Die Ressourcen werden nach ihren Anzeigenamen auf der linken Seite der Seite "API-Test" aufgeführt.
  5. Geben Sie eine kurze Beschreibung der Ressource an.

    Nachdem Sie eine Beschreibung eingegeben haben, wird der URI unter dem Beschreibungsfeld angezeigt.

  6. (Optional) Geben Sie einen RAML-Ressourcentyp an, der den Ressourcentyp (resourcesType:) darstellt. Sie müssen keinen Ressourcentyp angeben. Wenn Sie einen Ressourcentyp verwenden möchten, aber keinen definierten Typ haben, klicken Sie auf den Link Typen und definieren einen Typ.

Wenn Sie eine Methode für eine Ressource erstellen, wird unter dem Link Methoden ein Symbol für diese Methode angezeigt. Sie können sofort sehen, welche Methoden für eine Ressource definiert sind, wenn Sie eine Ressourcendefinition prüfen müssen. Klicken Sie auf ein Symbol, um direkt zu dieser Methodendefinition zu gehen.

Sie können die Übersichtlichkeit deaktivieren, um schnell eine Ressource zu finden, indem Sie in den Kompaktmodus wechseln (der Bereich befindet sich rechts von der neuen Ressource ). In der kompakten Anzeige werden die Ressourcenbeschreibung, der Ressourcentyp und der Pfad ausgeblendet.

Methoden zu Ressourcen hinzufügen

Methoden sind Aktionen, die für eine Ressource ausgeführt werden können. Auf der Seite "Methoden" wird jeweils eine Methode angezeigt. Nachdem mindestens zwei Methoden definiert wurden, können Sie auf das Symbol für eine Methode am Anfang der Seite klicken, um die Details anzuzeigen.

  1. Fügen Sie der Ressource einige Methoden hinzu, indem Sie auf Methoden klicken.

    Wenn die Ressource, für die Sie Methoden definieren, Pfadparameter enthält, werden diese oberhalb von Methode hinzufügen angezeigt.

    1. (Optional) Klicken Sie auf Erforderlich , wenn die Pfadparameter mit jeder Methode übergeben werden sollen.
      Der Parametername wird angezeigt.
    2. Geben Sie einen Anzeigenamen für den Parameter und Beispielcode an.
    3. Wählen Sie in der Dropdown-Liste den gültigen Werttyp für den Parameter aus.
  2. Klicken Sie auf Methode hinzufügen, und wählen Sie die gewünschte Methode aus.

    Nachdem Sie eine Methode gewählt haben, wird sie nicht mehr in der Methodenliste aufgeführt, weil Sie eine Methode nur einmal pro Ressource verwenden (Beispiel: Sie können nicht zwei DELETE-Methoden für eine einzelne Ressource definieren). Oben auf der Seite wird ein Symbol für jede Methode angezeigt, die Sie definieren. Klicken Sie auf ein Methodensymbol, um direkt zu seiner Definition zu navigieren.

  3. (Optional) Geben Sie eine kurze Beschreibung der Methode in das Feld Beschreibung ein.
  4. (Optional) Geben Sie einen Anzeigenamen für die Methode ein.
  5. (Optional) Geben Sie beliebige Trails an, die auf die Methode angewendet werden sollen.

    Wenn keine Ressourcen-Trails definiert sind, klicken Sie auf Endpunkte , um zur Hauptressourcenseite zurückzukehren, und klicken Sie auf den Link Durchlauf, um sie zu definieren. Mit dieser Leiste können Sie eine Sammlung ähnlicher Vorgänge definieren.

Nachdem Sie Methoden für die Ressource definiert haben, können Sie die Anforderungen und Antworten für diese Methoden definieren.

Anforderung für die Methode definieren

Nachdem Sie eine Methode gewählt haben, definieren Sie die Anforderung, die Sie aus dem Service erstellen, zu dem Sie eine Verbindung herstellen möchten. Beispiel: Wenn Sie eine POST-Methode ausgewählt haben, können Sie jetzt definieren, was erstellt werden soll. Dazu fügen Sie Parameter und einen Anforderungstext hinzu, der die Beschreibung der Daten enthält, die an den Service gesendet werden sollen.

  1. Klicken Sie auf Anforderung , um eine Anforderung zu definieren.
  2. Klicken Sie auf Parameter hinzufügen , und wählen Sie einen Parametertyp aus: Abfrage oder Header . Wählen Sie Erforderlich aus, wenn der Parameter für die Methode erforderlich ist.
    1. Geben Sie dem Parameter einen Namen und einen Anzeigenamen.
    2. Wählen Sie einen gültigen Werttyp aus: Zeichenfolge , Zahl , Ganzzahl , Datum oder Boolesch .
    3. (Optional) Geben Sie eine Beschreibung des Parameters und ein Beispiel an, das Sie beim Testen der Gültigkeit des Endpunkts verwenden können. Beispiel: Sie haben eine Ressource, audits, und fügen einen Abfrageparameter, auditorID, der einen Zahlenwert akzeptiert, und einen anderen Parameter, auditName, der einen Zeichenfolgenwert übernimmt:
      /audits: 
        get: 
          description: | 
            Gets list of audits, organizations etc.     
          queryParameters: 
            auditorID:  
              id: Auditor ID
              description: | 
                display auditor identifier 
              type: integer 
              example: |
                1234
              required: false      
            auditName:
              displayName: auditName
              description: |
                Audit name
              example: "Payroll Process Audit"

      In diesem Beispiel wird eine GET-Methode mit den Abfrageparameter auditorID und auditName definiert.

    4. (Optional) Klicken Sie auf Weitere Eigenschaften , um dem Parameter verschachtelte Eigenschaften hinzuzufügen. Klicken Sie auf Wiederholen , um ein Vielfaches des aktuellen Parameters hinzuzufügen.
    5. Klicken Sie auf Parameter hinzufügen , um einen weiteren Parameter der obersten Ebene für die Methode hinzuzufügen.
  3. Klicken Sie je nach gewählter Methode auf Medientyp hinzufügen , und definieren Sie den Methodenhauptteil. Der Text enthält die Daten, die Sie an den Server senden. Beispiel: Wenn Sie eine POST-Methode definieren, müssen Sie den zu erstellenden Artikel definieren, wie eine neue Kundenliste oder eine Serviceanfrage. Wenn Sie eine GET-Methode definieren, müssen Sie keinen Methoden-Body senden, sodass Sie keinen Medientyp angeben müssen.
    1. Wählen Sie den Medientyp für den Methodenhauptteil, d.h. das Format der zu sendenden Nachricht, wie Text, Bilder oder Webformulare.
      Je nach Typ (Beispiel: Sie sollten kein Schema für einen Imagetyp eingeben) können Sie ein Schema oder ein Beispiel oder beides hinzufügen.

      Fügen Sie bei der Definition eines Schemas nur die Daten hinzu, die für den Zweck der Ressource erforderlich sind. Das heißt, nicht erforderliche Daten hinzufügen, die nur die Übertragung verlangsamen und möglicherweise das Risiko von Fehlern erhöhen.

    2. (Optional) Klicken Sie auf Schema , und geben Sie im Editorbereich ein Schema (im JSON-Format) ein. Ein Schema entspricht einer Vorlage für den Body. Sie definieren den Inhalt der Nachricht.
    3. (Optional) Klicken Sie auf Beispiel , und geben Sie ein Beispiel (im JSON-Format) im Editorbereich ein, das von der Pseudoimplementierung als Pseudo-Antwort für die Methode verwendet wird. Durch die Verwendung von Pseudodaten können Sie das Verhalten Ihrer Methoden prüfen. Das Beispiel zeigt die Pseudowerte für die Daten, die im Nachrichtentext gesendet werden, wie in der POST-Methode der Ressource audits definiert:
      body: 
        application/json: 
          example: | 
            { 
              "Title": "Leaking Water Heater",
              "Username": "joh1017",  
              "imageLink": "storage/collections/2e029813-d1a9-4957-a69a-fbd0d7431d77/objects/6cdaa3a8-097e-49f7-9bd2-88966c45668f?user=lynn1014", 
              "Notes": "my water heater is broken"
            }                               
      
  4. Klicken Sie auf Medientyp hinzufügen , um zusätzliche Medientypen hinzuzufügen. Wenn Sie die Methode nicht mehr benötigen, klicken Sie im Banner auf X , um sie zu löschen.

Antwort für die Methode definieren

Je nach Anforderung ist möglicherweise eine Antwort erforderlich. Eine Antwort beschreibt den Prozess zum Zurückgeben von Ergebnissen aus dem Service. Möglicherweise möchten Sie eine Antwort definieren, mit der geprüft wird, ob die angeforderten Daten zurückgegeben wurden, oder ob eine Antwort die Anforderung empfangen wurde. Die Definition einer Antwort ähnelt der Definition einer Anforderung. Der Hauptunterschied besteht darin, dass Sie einen Statuscode auswählen müssen, damit Sie das Ergebnis der Verbindung kennen.

  1. Klicken Sie auf Antwort , um eine oder mehrere Antworten zu definieren.
  2. Klicken Sie auf Antwort hinzufügen, und wählen Sie den Statuscode aus, den Sie zurückgeben möchten.

    Ein Statuscode von 200 wird standardmäßig bereitgestellt. Wenn dies nicht der gewünschte Code ist, wählen Sie einen Wert aus der Dropdown-Liste aus.

    • 2 xx gibt an, dass eine erfolgreiche Verbindung besteht.

    • 3 xx gibt an, dass eine Umleitung erfolgt ist.

    • 4 xx gibt an, dass ein Benutzerfehler aufgetreten ist.

    • 5 xx gibt an, dass ein Serverfehler aufgetreten ist.

    Um den Grund für einen potenziellen Fehler in der zu konfigurierenden API zu ermitteln, verwenden Sie einen HTTP-Statuscode, um den Code zurückzugeben, der am besten mit der Fehlersituation übereinstimmt.

  3. Geben Sie eine Beschreibung der Codebezeichnungen an.
  4. Klicken Sie auf Header hinzufügen, wählen Sie einen Antwortheader oder eine Abfrage aus, geben Sie den Namen des Headers oder der Abfrage und einen Anzeigenamen für den Header an sowie den gültigen Werttyp für den Header.
  5. Klicken Sie auf Medientyp hinzufügen, und wählen Sie das Format der Antwort aus. Je nach dem ausgewählten Medientyp können Sie Parameter, Schemas oder Beispiele genau wie im Anforderungstext hinzufügen.
    1. Klicken Sie für den textbasierten Medientyp (z.B. application/json oder text/xml) auf Schema , um ein Schema (im JSON-Format) für den Body einzugeben.
      Wie im Anforderungstext fügen Sie dem Antworttext nur entsprechende Daten hinzu. Nehmen Sie nicht mehr Daten auf, als für den Vorgang erforderlich sind.
    2. Klicken Sie auf Beispiel , um die Pseudodaten (im JSON-Format) für den Antworttext hinzuzufügen. Überprüfen Sie mit den Pseudodaten das Verhalten Ihrer Methoden, bevor Sie mit echten Daten testen.
    3. Bei formularbasierten Medientypen (z.B. multipart/form-data) klicken Sie auf Parameter hinzufügen und wählen Erforderlich , wenn der Parameter obligatorisch ist. Geben Sie dann einen Namen an, und wählen Sie einen Werttyp aus. Optional können Sie dem Parameter einen Namen geben.
    4. Bei einem image-basierten Medientyp (z.B. image/png) müssen Sie keine Aktion ausführen, weil keine Schemas oder Attribute zur Bereitstellung vorhanden sind.
Das folgende Beispiel zeigt, dass eine Antwort für die POST-Methode der audits-Ressource mit dem Statuscode 201 erstellt wurde, was darauf hinweist, dass eine neue Ressource erfolgreich erstellt wurde. Das Beispiel zeigt außerdem das Rückgabeantwortformat application/json, den Header Location und den Nachrichtentext mit den Pseudodaten:
responses: 
  201: 
    description: | 
      The request has been fulfilled and resulted in a new resource 
      being created. The newly created resource can be referenced  
      by the URI(s)returned in the entity of the response, with the 
      most specific URI for the resource given by a Location header
      field.  

    headers:
      Location:
        displayName: Location
        description: |
          Identifies the location of the newly created resource.

        type: string
        example: |
          /20934

        required: true

    body: 
      application/json: 
        example: | 
          {
            "id": 20934,
            "title": "Lynn's Leaking Water Heater",
            "contact": {
               "name": "Lynn Adams",                 
               "street": "45 O'Connor Street",
               "city": "Ottawa", 
               "postalcode": "a1a1a1",
               "username": "johnbeta"
              },
           "status": "New",
           "driveTime": 30,
           "priority": "high",
           "notes": "My notes",
           "createdon": "2014-01-20 23:15:03 EDT",
           "imageLink": "storage/collections/2e029813-d1a9-4957-a69a-fbd0d74331d77/objects/6cdaa3a8-097e-49f7--9bd2-88966c45668f?user=lynn1014"
          }

Wenn Sie die Antwort definieren, können Sie die Endpunkte testen oder in der Navigationsleiste auf Endpunkte klicken, um zur Hauptseite "Ressourcen" zurückzukehren. Von dort aus können Sie zu einer anderen Seite im API-Designer gehen, um Root-, Ressourcentypen oder Trails zu erstellen oder API-Dokumentation hinzuzufügen.

Wenn Sie die Methode nicht wünschen, klicken Sie im Banner auf X , um sie zu löschen.

REST-Connector-API erstellen

Mit dem REST Connector-API-Assistenten können Sie die Connector-API erstellen, konfigurieren und testen.

Um eine einfache Arbeits-Connector-API zu erhalten, können Sie den Namen für die Connector-API und eine URL zum externen Service angeben.

Von dort können Sie:

  • Definieren Sie Regeln für das Formular bestimmter Anforderungen oder Antworten für die Daten, auf die Sie zugreifen möchten.

  • Konfigurieren Sie clientseitige Sicherheits-Policys für den Service, auf den Sie zugreifen.

  • Testen Sie die Verbindung, und testen Sie die Ergebnisse von Aufrufen für die Verbindung.

Sie müssen eine benutzerdefinierte API und Implementierung erstellen, damit Ihre Anwendungen die Connector-APIs aufrufen und die API und Implementierung automatisch generieren können. Wenn Sie dies manuell tun möchten, müssen Sie eine benutzerdefinierte API mit den entsprechenden Ressourcen erstellen und dann den benutzerdefinierten Code implementieren.

Basis-Connector einrichten

Sie können einen funktionsfähigen Connector erstellen, indem Sie die ersten beiden Seiten des REST Connector-API-Assistenten abschließen.

  1. Klicken Sie auf symbol für Seitenmenü öffnen, und wählen Sie im Seitenmenü Entwicklung, APIs aus.

  2. Klicken Sie auf REST (wenn dies die erste zu erstellende Connector-API ist) oder auf Neuer Connector , und wählen Sie REST aus der Dropdown-Liste.

  3. Geben Sie die neue REST-Connector-API wie folgt an:

    1. API-Anzeigename: Der Name , wie er in der Liste der Connector-APIs angezeigt wird.

    2. API-Name: Der eindeutige Name für die Connector-API.

      Standardmäßig wird dieser Name an den relativen Basis-URI als Ressourcenname für die Connector-API angehängt. Unter dem Feld "API-Name " wird die Basis-URI angezeigt.

      Anders als eine neue Version dieser Connector-API kann keine andere Connector-API denselben Ressourcennamen haben.

    3. Kurzbeschreibung: Diese Beschreibung wird auf der Seite "Connectors" angezeigt, wenn diese API ausgewählt wird.

  4. Klicken Sie auf Erstellen .

  5. Legen Sie auf der Seite "Allgemein" des Dialogfeldes "REST Connector-API" die Timeoutwerte fest:

    • HTTP-Lesetimeout: Die maximale Zeit (in Millisekunden), die beim Warten auf das Lesen der Daten verbracht werden kann. Wenn Sie keinen Wert angeben, wird der Standardwert von 20 Sekunden angewendet.

    • HTTP-Verbindungs-Timeout: Die Zeit (in Millisekunden) für die Verbindung mit der Remote-URL. Ein Wert von 0mms bedeutet, dass ein endloser Timeout zulässig ist.

      Die HTTP-Timeout-Werte müssen kleiner sein als die Policy Network_HttpRequestTimeout, die einen Standardwert von 40,000 ms hat.

      Hinweis:

      Wenn Sie zusätzlich zu Ihrer Serviceentwicklerrolle über eine Mobile Cloud-Administratorrolle verfügen, können Sie die Datei policies.properties öffnen, um den Wert für die Netzwerk-Policys für die aktuelle Umgebung über die Administratoransicht anzuzeigen. Sonst fragen Sie den Mobile Cloud-Administrator nach den Werten.
  6. Klicken Sie auf Deskriptor, und geben Sie die Verbindungsinformationen für den Service ein.

    Wenn Sie eine Swagger-Deskriptor-URL angeben, werden die verfügbaren Ressourcen identifiziert und angezeigt, und Sie können die gewünschten Ressourcen auswählen.

    Hinweis:

    Nur standardmäßige Internetzugriffsports 80 und 443 werden unterstützt. Die Verbindung zu einem Service kann nicht über einen benutzerdefinierten Port hergestellt werden.
  7. Klicken Sie auf Speichern .

  8. (Optional) Klicken Sie auf Testen , wählen Sie die Zugangsdaten für die Authentifizierung aus, und machen Sie Testaufrufe an den Service.

Hier können Sie den Connector wie folgt weiter konfigurieren:

  • (Wenn Sie einen Deskriptor auf der Seite "Deskriptor" angegeben haben) gehen Sie zu der Seite "Ressourcen " und wählen die Methoden für die angegebenen Ressourcen.

  • Regeln definieren.

  • Legen Sie Sicherheits-Policys fest.

Um sicherzustellen, dass die Connector-API-Konfiguration gültig ist, sollten Sie sie gründlich (nicht nur auf der Seite "Connector API-Test") testen, bevor Sie sie veröffentlichen. Das heißt, Sie sollten auch die benutzerdefinierte API (mit deren Implementierung) testen, die diese Connector-API verwendet. Wenn Sie bereit sind, die Connector-API zu veröffentlichen, sollten Sie auch die benutzerdefinierte API veröffentlichen, die sie aufruft.

Regeln einrichten

Sie legen Regeln zum Definieren der Interaktionen zwischen Ihrer App und einem Service fest. Mit Regeln können Sie Standardparameterwerte für alle Aufrufe von Ressourcen auf dem Service, Aufrufe an einen bestimmten Proxypfad und Aufrufe für bestimmte Typen von Vorgängen (Verben) hinzufügen. Auf diese Weise kann die konsistente Syntax der URL-Zeichenfolge durchgesetzt werden. Der Entwickler des benutzerdefinierten Codes muss diese Werte einfügen und kann die verschiedenen Aufrufe durch Analysen verfolgen.

Sie können eine oder mehrere Regeln erstellen. Jede Regel kann einen oder mehrere Parameter vom Typ Query und Header enthalten.

Wenn keine Regeln angewendet werden, werden alle Aufrufe durch den Proxy an den vorhandenen Service übergeben.

  1. Wenn der Connector noch nicht geöffnet ist, klicken Sie auf symbol für Seitenmenü, und wählen Sie Entwicklung und dann APIs aus dem Seitenmenü.
  2. Wählen Sie die zu bearbeitende Connector-API, und klicken Sie auf Öffnen .
  3. Wählen Sie Rollen .
  4. Klicken Sie auf Neue Regel .
  5. Klicken Sie auf Parameter hinzufügen, wählen Sie einen Abfrage- oder Headerparametertyp aus, und geben Sie den Abfrage- oder Headernamen und den zugehörigen Wert ein.

    Hinweis:

    Sie können zwar Regeln definieren, um bestimmte Header standardmäßig festzulegen, die Regeln werden jedoch nicht angewendet, wenn der Client, der den Connector direkt über benutzerdefinierten Code oder indirekt aufgerufen hat, wie über einen Webbrowser oder eine mobile App, bereits dieselben Header festgelegt hat.

    Zum Festlegen des Formats des Anforderungstextes erfolgt In der Regel im benutzerdefinierten Code mit dem Header Content-Type und nicht als REST Connector-Regel. Genauso wird das Format des Antworttextes auch im benutzerdefinierten Code mit dem Header Accept und nicht als REST Connector-Regel festgelegt.

    Sie können einer Regel beliebig viele Parameter hinzufügen, jedoch ist es besser, eine Regel mit zu vielen Vorgängen zu überlasten. Ein einfacheres Regelkonstrukt ist einfacher zu beheben.

  6. Blenden Sie Ressourcen ein, und bearbeiten Sie die Remote-URL, um eine Ressource für die Regel anzugeben, auf die angewendet werden soll. Der Wert der Basis-URL entspricht dem Wert, den Sie in den Schritt zur Festlegung der grundlegenden Informationen eingegeben haben und kann nicht bearbeitet werden.
  7. Wählen Sie Nicht für Ressourcen der niedrigeren Ebene anwenden , wenn die Regeln nur auf die in der Remote-URL angegebene Ressourcenebene angewendet werden sollen.
  8. (Optional) Heben Sie die Auswahl der HTTP-Methoden auf, die Sie nicht auf die gerade definierten Regeln anwenden möchten. Standardmäßig sind alle Methoden gewählt.
  9. (Optional) Klicken Sie auf Neue Regel , um eine weitere Regel zu erstellen.

    Hinweis:

    Wenn Sie eine Regel definieren, die mit einer anderen Regel in Konflikt steht, hat die erste angewendete Regel Vorrang, und die unvereinbare Regel wird ignoriert.

    Wenn Sie fertig sind, klicken Sie auf Speichern und danach auf Weiter ( > ), um zum nächsten Schritt bei der Konfiguration der Connector-API zu gehen.

Die Beschreibung der Regel, die Sie gerade definiert haben, wird im Banner Regel direkt über dem Abschnitt Standardparameter angezeigt. Beispiel: Die folgenden Werte wurden bereitgestellt:

  • Remote-URL = https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle

  • Lokale URI = myMapAPI

  • Regel mit dem folgenden Parameter: Query:key:A3FAEAJ903022

  • GET und PUT HTTP-Methoden

Die Regelbeschreibung würde wie folgt gelesen werden:

Für GET bis https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle in myMapAPI/directions, Query:key=A3FAEAJ903022 einschließen.

Wenn keine Regeln erstellt wurden, würde die Beschreibung folgendermaßen lauten:

Für ALL METHODS für https://maps.googleapis.com/maps/api/directions, das unter myMapAPI verfügbar ist, werden keine Standardparameter angewendet.

Jetzt haben Sie eine Basis-URI, die dem vorhandenen Service zugeordnet ist. Beispiel:

mobile/connector/myMapAPI/directions/json?origin=los+angeles&destination=seattle Zuordnungen zu https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle

Sicherheits-Policys konfigurieren und Eigenschaften außer Kraft setzen

Bevor Sie die Connector-API fertigstellen, sollten Sie in Erwägung ziehen, wie die zugehörige Sicherheit verarbeitet wird. Sie können Sicherheits-Policys oder Autorisierungs-Header verwenden. Die Auswahl einer Sicherheits-Policy, die das Authentifizierungsschema des Service beschreibt, mit dem Sie sich verbinden, ist der empfohlene Ansatz.

Jede Sicherheits-Policy weist Eigenschaften auf, die als Overrides bezeichnet werden, die Sie konfigurieren können. Ein Grund für das Außerkraftsetzen einer Policy-Konfigurationseigenschaft besteht darin, die Anzahl von Policys zu begrenzen, die Sie verwalten müssen: Anstatt mehrere Policys mit leicht abweichenden Konfigurationen zu erstellen, können Sie dieselbe generische Policy verwenden und spezifische Werte entsprechend Ihren Anforderungen außer Kraft setzen.

So wählen Sie eine Sicherheits-Policy und legen die Policy Overrides fest:

  1. Wenn der Connector noch nicht geöffnet ist, klicken Sie auf symbol für Seitenmenü, und wählen Sie Entwicklung, APIs aus dem Seitenmenü aus.
  2. Wählen Sie die zu bearbeitende Connector-API, und klicken Sie auf Öffnen .
  3. Wählen Sie Sicherheit.
  4. Wählen Sie die Sicherheits-Policy aus der Liste der verfügbaren Policys, und klicken Sie auf den Pfeil nach rechts, um sie in die Liste "Gewählte Policys" zu verschieben.
    Wählen Sie nur eine einzelne Policy für die Connector-API. Unter der Liste wird eine Beschreibung der gewählten Policy angezeigt.
  5. Geben Sie gegebenenfalls Überschreibungen für die ausgewählte Policy an, wenn Sie die Standardwerte nicht verwenden möchten.
    Um eine Eigenschaft zu überschreiben, geben Sie einen anderen Wert als den Standardwert ein, oder wählen Sie diesen aus.
  6. Klicken Sie auf Speichern , um Ihre Arbeit zu speichern, oder auf Speichern und schließen , um Ihre Arbeit zu speichern und den REST Connector-API-Assistenten zu beenden.
  7. Klicken Sie auf Weiter ( > ), um zum nächsten Schritt zu gehen.