Benutzerdefinierte API für einen Faruptiade REST-Service implementieren

Wenn Sie eine App entwickeln, beginnen Sie in der Regel zuerst mit der Benutzeroberflächenschicht, und verbinden Sie die Anwendung mit einer anderen Anwendung mit den REST-Webservices. Dieser Ansatz eignet sich gut 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 ist Best Practice, die API-Ebene für externe Backend-Services und die Benutzeroberfläche zu erstellen, um möglichst die Anzahl der Aufrufe der Backend-Services zu reduzieren. Beispiel: Ihre App kann einen einzelnen Aufruf der Facade API-Ebene ausführen, die die Aufrufe anderer REST-Services verarbeitet, und alle eingehenden Daten in einer einzigen 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 crux einer API. Sie hat einen Typ, einige mit ihm verknüpfte Daten, eine Beziehung zu anderen Ressourcen und enthält eine oder mehrere Methoden, die darauf reagieren. Eine Ressource kann nahezu alles sein: ein Bild, eine Textdatei, eine Zusammenstellung anderer 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.

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

    Hinweis:

    Siehe die Symbole unter den Links Methoden? Jedes Mal, wenn Sie eine Methode für eine Ressource definieren, wird unter dem Link "Methoden" ein Symbol für die Ressource angezeigt. Verwenden Sie sie als Shortcuts, um festzustellen, welche Methoden schon für eine Ressource definiert wurden. Klicken Sie auf ein Symbol, um direkt zu der Definition auf der Seite "Methoden" zu gehen.
  3. Geben Sie den Ressourcenpfad an, der die URI ist (relativ zur Basis-URI). Beispiel: Wenn die Basis-URI /mobile/custom/audits/ ist, können Sie die Ressource findings hinzufügen, d.h. /mobile/custom/audits/findings.
  4. Geben Sie den Anzeigenamen an. Dies ist ein Name für die Ressource, der die Identifizierung in der API-Dokumentation erleichtert.
    Ressourcen werden auf der linken Seite der API-Testseite nach Anzeigenamen aufgelistet.
  5. Geben Sie eine kurze Beschreibung der Ressource an.

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

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

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 überprüfen müssen. Klicken Sie auf ein Symbol, um direkt zu dieser Methodendefinition zu gehen.

Sie können die Übersichtlichkeit löschen, um eine Ressource schneller zu finden, indem Sie in den Komprimieren-Modus wechseln (er ist rechts neben Neue Ressource ). Durch die kompakte Anzeige werden Ressourcenbeschreibung, Ressourcentyp und Pfad ausgeblendet.

Methoden zu Ihren Ressourcen hinzufügen

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

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

    Wenn die Ressource, für die Sie Methoden definieren, Pfadparameter hat, werden diese über 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.
  2. Klicken Sie auf Methode hinzufügen, und wählen Sie die gewünschte Methode.

    Nachdem Sie eine Methode ausgewä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). Ein Symbol für jede definierte Methode wird oben auf der Seite angezeigt. Klicken Sie auf ein Methodensymbol, um direkt zu der Definition zu gehen.

  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 alle Trails an, die auf die Methode angewendet werden sollen.

    Wenn keine Resource Trails definiert sind, klicken Sie auf Endpunkte, um zu der Hauptseite Ressourcen zurückzugehen, und klicken auf den Link Traits, um einen zu definieren. Mit dem Schieberegler 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.

Definieren Sie eine Anforderung für die Methode

Nachdem Sie eine Methode ausgewählt haben, definieren Sie die Anforderung, mit der Sie den Service verbinden möchten. Beispiel: Wenn Sie die Methode POST gewä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 einen Namen und einen Anzeigenamen für den Parameter an.
    2. Wählen Sie einen gültigen Werttyp aus: String, Number, Integer, Date oder Boolean.
    3. (Optional) Geben Sie eine Beschreibung des Parameters und ein Beispiel an, das Sie verwenden können, wenn Sie die Gültigkeit des Endpunkts testen. Beispiel: Sie haben eine Ressource audits und fügen einen Abfrageparameter auditorID hinzu, der einen Zahlenwert und einen anderen Parameter, auditName, der einen Zeichenfolgenwert annimmt:
      /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 Abfrageparametern auditorID und auditName definiert.

    4. (Optional) Klicken Sie auf Weitere Eigenschaften, um dem Parameter verschachtelte Eigenschaften hinzuzufügen. Klicken Sie auf Wiederholen, um mehrere Elemente 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. Je nach ausgewählter Methode klicken Sie auf Medientyp hinzufügen und definieren den Methoden-Body. Der Hauptteil enthält die Daten, die Sie an den Server senden. Beispiel: Wenn Sie eine POST-Methode definieren, müssen Sie das Element definieren, das Sie erstellen, z. B. eine neue Kundenliste oder eine Serviceanfrage. Wenn Sie eine GET-Methode definieren, müssen Sie keinen Methoden-Body senden, damit Sie keinen Medientyp angeben müssen.
    1. Wählen Sie den Medientyp für Ihren Methodentext aus, d.h. das Format der zu sendenden Nachricht, wie Text, Bilder oder Webformulare.
      Je nach Typ (Beispiel: Sie würden kein Schema für einen Bildtyp eingeben), können Sie ein Schema oder ein Beispiel oder beides hinzufügen.

      Bei der Definition eines Schemas fügen Sie nur die Daten hinzu, die für den Zweck der Ressource erforderlich sind. Das heißt, fügen Sie keine unnötigen Daten hinzu, die die Übertragung nur verlangsamen und das Potenzial möglicherweise bei 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 Hauptteil. Mit diesem Inhalt wird der Inhalt der Nachricht definiert.
    3. (Optional) Klicken Sie auf Beispiel, und geben Sie im Editorbereich ein Beispiel (im JSON-Format) ein, das von der Pseudoimplementierung als Pseudoantwort für die Methode verwendet wird. Mit Pseudodaten können Sie das Verhalten Ihrer Methoden prüfen. Das Beispiel zeigt Mock-Werte 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 benötigen, klicken Sie im Banner auf X, um sie zu löschen.

Antwort für die Methode definieren

Je nach Anforderung benötigen Sie möglicherweise eine Antwort. Eine Antwort beschreibt den Prozess für die Rückgabe von Ergebnissen vom Service. Möglicherweise möchten Sie eine Antwort definieren, mit der geprüft wird, ob die angeforderten Daten zurückgegeben wurden, oder Sie möchten eine Antwort erhalten, die bestätigt, ob 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 können.

  1. Klicken Sie auf Antwort, um eine oder mehrere Antworten zu definieren.
  2. Klicken Sie auf Antwort hinzufügen, und wählen Sie den gewünschten Statuscode.

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

    • 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 eines potenziellen Fehlers in der von Ihnen konfigurierten API anhand der API zu verstehen, verwenden Sie einen HTTP-Statuscode, um den Code zurückzugeben, der am besten zu der Fehlersituation passt.

  3. Gibt eine Beschreibung der Angabe des Codes an.
  4. Klicken Sie auf Header hinzufügen, wählen Sie einen Antwortheader oder eine Abfrage, geben Sie den Namen des Headers oder der Abfrage sowie einen Anzeigenamen für den Header und den gültigen Werttyp für den Header an.
  5. Klicken Sie auf Medientyp hinzufügen, und wählen Sie das Format der Antwort aus. Je nach gewähltem Medientyp können Sie Parameter, Schemas oder Beispiele wie bei dem Anforderungstext hinzufügen.
    1. Klicken Sie bei dem textbasierten Medientyp (z. B. application/json oder text/xml) auf Schema, um ein Schema (im JSON-Format) für den Hauptteil einzugeben.
      Wie bei dem Anforderungstext fügen Sie nur relevante Daten zu dem Antworttext hinzu. Nehmen Sie keine weiteren Daten auf, als Sie den Vorgang tatsächlich benötigen.
    2. Klicken Sie auf Beispiel, um Pseudodaten (im JSON-Format) für den Antworttext hinzuzufügen. Verwenden Sie Pseudodaten, um das Verhalten Ihrer Methoden vor dem Testen mit echten Daten zu prüfen.
    3. Klicken Sie bei einem formularbasierten Medientyp (z. B. multipart/form-data) auf Parameter hinzufügen, und wählen Sie Erforderlich, wenn der Parameter obligatorisch ist. Geben Sie dann einen Namen an, und wählen Sie einen Werttyp. Optional können Sie dem Parameter einen Namen geben.
    4. Bei einem image-basierten Medientyp (Beispiel: image/png) müssen Sie keinen Vorgang ausführen, weil keine Schemas oder Attribute zur Angabe vorhanden sind.
Das folgende Beispiel zeigt, dass eine Antwort für die Methode POST der Ressource audits mit dem Statuscode 201 erstellt wurde, der angibt, dass eine neue Ressource erfolgreich erstellt wurde. Das Beispiel zeigt außerdem ein Antwortformat application/json, einen Location-Header, der hinzugefügt wurde, und den Nachrichtentext, der Pseudodaten enthält:
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 Ihre Endpunkte testen oder auf Endpunkte in der Navigationsleiste klicken, um zur Hauptressourcenseite zurückzukehren. Von dort können Sie zu einer anderen Seite im API-Designer gehen, um eine Root, Ressourcentypen oder Trails zu erstellen oder API-Dokumentation hinzuzufügen.

Wenn Sie die Methode nicht benötigen, klicken Sie im Banner auf X, um sie zu löschen.

REST -Connector-API erstellen

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

Um eine Basis-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 spezifische 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 der Aufrufe der 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. In diesem Fall 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 ausfüllen.

  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 aus der Dropdown-Liste REST.

  3. Identifizieren Sie die neue REST-Connector-API mit folgenden Angaben:

    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 die relative Basis-URI als Ressourcenname für die Connector-API angehängt. Unter dem Feld "API-Name " sehen Sie die Basis-URI.

      Außer einer neuen Version dieser Connector-API darf keine andere Connector-API denselben Ressourcennamen haben.

    3. Kurze Beschreibung: 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 mit dem Warten auf das Lesen der Daten verbracht werden kann. Wenn Sie keinen Wert angeben, wird der Standardwert von 20 Sekunden angewendet.

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

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

      Hinweis:

      Wenn Sie zusätzlich zur Rolle des Serviceentwicklers ü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 in der Administratorenansicht anzuzeigen. Bitten Sie andernfalls den Mobile Cloud-Administrator um die Werte.
  6. Klicken Sie auf Deskriptor, und geben Sie die Verbindungsinformationen für den Service ein.

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

    Hinweis:

    Nur Standard-Internet-Zugriffsports 80 und 443 werden unterstützt. Eine 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 Authentifizierungszugangsdaten aus, und führen Sie Testaufrufe an den Service durch.

Dort 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.

  • Definieren Sie Regeln.

  • Sicherheits-Policys festlegen.

Um sicherzustellen, dass die Connector-API-Konfiguration gültig ist, sollten Sie sie vor der Veröffentlichung gründlich testen (nicht nur über die Connector-API-Testseite). Das heißt, Sie müssen auch die benutzerdefinierte API (mit ihrer Implementierung) testen, die diese Connector-API verwendet. Wenn Sie bereit sind, die Connector-API zu veröffentlichen, sollten Sie außerdem die benutzerdefinierte API veröffentlichen, die sie aufruft.

Regeln festlegen

Sie legen Regeln für die Definition der Interaktionen zwischen Ihrer App und einem Service fest. Mit Regeln können Sie Standardparameterwerte für alle Aufrufe an Ressourcen in dem Service, Aufrufe an einen bestimmten Proxypfad und Aufrufe für bestimmte Vorgangstypen (Verben) hinzufügen. Dadurch kann die konsistente Syntax der URL-Zeichenfolge erzwungen werden, der Entwickler des benutzerdefinierten Codes muss diese Werte einfügen, und die verschiedenen Aufrufe können über Analysen verfolgt werden.

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

Wenn keine Regeln angewendet werden, werden alle Aufrufe an den vorhandenen Service durch den Proxy ü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 Connector-API aus, die Sie bearbeiten möchten, und klicken Sie auf Öffnen.
  3. Wählen Sie Rollen aus.
  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 Namen der Abfrage oder des Headers und seinen Wert ein.

    Hinweis:

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

    Das Einrichten des Anforderungstextformats erfolgt normalerweise im benutzerdefinierten Code mit dem Header Content-Type und nicht als REST Connector-Regel. Ebenso 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 so viele Parameter wie gewünscht hinzufügen, es ist jedoch besser, eine Regel mit zu vielen Vorgängen zu überlasten. Ein einfacheres Regelkonstrukt ist einfacher zur Fehlerbehebung.

  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 im Schritt "Basisinformationen festlegen" eingegeben haben und kann nicht bearbeitet werden.
  7. Wählen Sie Auf Ressourcen niedrigerer Ebene nicht anwenden, wenn die Regeln nur auf die Ressourcenebene angewendet werden sollen, die in der Remote-URL angegeben ist.
  8. (Optional) Heben Sie die Auswahl der HTTP-Methoden auf, die nicht auf Regeln angewendet werden sollen, die Sie gerade definiert haben. 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 dann auf Weiter ( > ), um zum nächsten Schritt bei der Konfiguration der Connector-API zu gehen.

Die Beschreibung der gerade definierten Regel wird im Regelbanner direkt über dem Abschnitt Standardparameter angezeigt. Beispiel: Die folgenden Werte wurden angegeben:

  • 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

  • HTTP-Methoden GET und PUT

Die Regelbeschreibung würde folgendermaßen aussehen:

Für GET für https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle verfügbar unter myMapAPI/directions, Query:key=A3FAEAJ903022 einbeziehen.

Wenn keine Regeln erstellt wurden, würde die Beschreibung wie folgt lauten:

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

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

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

Sicherheits-Policys konfigurieren und Eigenschaften außer Kraft setzen

Bevor Sie die Connector-API fertigstellen, sollten Sie berücksichtigen, wie die Sicherheit behandelt werden soll. Sie können entweder Sicherheits-Policys oder Autorisierungsheader verwenden. Die Auswahl einer Sicherheits-Policy, die das Authentifizierungsschema des Service beschreibt, bei dem Sie sich anmelden, wird empfohlen.

Jede Sicherheits-Policy hat Eigenschaften, die als Overrides bezeichnet werden, die Sie konfigurieren können. Ein Grund, aus dem eine Policy-Konfigurationseigenschaft außer Kraft gesetzt wird, besteht darin, die Anzahl der zu verwaltenden Policys zu begrenzen: Anstatt mehrere Policys mit leicht unterschiedlichen Konfigurationen zu erstellen, können Sie dieselbe allgemeine Policy verwenden und bestimmte Werte außer Kraft setzen, um Ihre Anforderungen zu erfüllen.

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 Connector-API aus, die Sie bearbeiten möchten, 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. Eine Beschreibung einer ausgewählten Policy wird unter der Liste angezeigt.
  5. Geben Sie bei Bedarf Überschreibungen für die gewählte Policy an, wenn Sie die Standardwerte nicht verwenden möchten.
    Um eine Eigenschaft außer Kraft zu setzen, geben Sie einen anderen Wert als den Standardwert ein, oder wählen Sie ihn aus.
  6. Klicken Sie auf Speichern, um Ihre Arbeit zu speichern, oder auf Speichern und schließen, um Ihre Arbeit zu speichern und den Assistenten für die REST Connector-API zu beenden.
  7. Klicken Sie auf Weiter ( > ), um mit dem nächsten Schritt fortzufahren.