Benutzerdefinierte API für einen REST-Service für Fassaden implementieren

Wenn Sie eine mobile Anwendung entwickeln, beginnen Sie in der Regel zuerst mit der Benutzeroberflächenschicht und verbinden dann Ihre Anwendung mit einer anderen Anwendung über REST-Webservices. Dieser Ansatz eignet sich gut für kleine oder einfache Anwendungen. Wenn Anwendungen größer sind und Sie eine Verbindung zu mehreren Backend-Services herstellen möchten, können Sie versehentlich Performance- und Sicherheitsprobleme verursachen.

Es ist eine Best Practice, mit dem Erstellen einer Fassaden-API-Schicht zwischen den externen Backend-Services und der Benutzeroberfläche zu beginnen, um die Anzahl der Aufrufe an die Backend-Services nach Möglichkeit zu reduzieren. Beispiel: Ihre mobile Anwendung kann einen einzelnen Aufruf der Fassaden-API-Schicht ausführen, der die Aufrufe anderer REST-Services verarbeitet, und alle eingehenden Daten in einer einzigen Antwort auf Ihre mobile Anwendung konsolidieren.

Vollständige benutzerdefinierte API erstellen

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

Klicken Sie auf Seitenmenü-Symbol öffnen, und wählen Sie im Seitenmenü Entwicklung, APIs aus. Wenn bereits eine API erstellt wurde (ob 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 API, die Sie bereits erstellt haben, oder klicken Sie auf Neue API, um zu beginnen.

Endpunkte definieren

Sie erstellen Ressourcen, um die Endpunkte der API zu definieren. Eine Ressource ist der Kern einer API. Es hat einen Typ, mit dem einige Daten verknüpft sind, eine Beziehung zu anderen Ressourcen und enthält eine oder mehrere Methoden, die darauf reagieren. Eine Ressource kann fast alles sein: ein Bild, eine Textdatei, eine Sammlung 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.

    Jedes Mal, wenn Sie auf Neue Ressource klicken, erstellen Sie eine Ressource der obersten Ebene (Root). 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:

    Sehen Sie die Symbole unter den Links Methoden? Jedes Mal, wenn Sie eine Methode für eine Ressource definieren, wird unter dem Link "Methoden" ein Symbol dafür angezeigt. Verwenden Sie sie als Shortcuts, um zu sehen, welche Methoden bereits für eine Ressource definiert wurden. Klicken Sie auf ein Symbol, um direkt zu seiner Definition auf der Seite "Methoden" zu gelangen.
  3. Geben Sie den Ressourcenpfad an, der die URI (relativ zur Basis-URI) ist. Beispiel: Wenn die Basis-URI /mobile/custom/audits/ lautet, können Sie die Ressource findings (/mobile/custom/audits/findings) hinzufügen.
  4. Geben Sie den Anzeigenamen an. Dies ist ein Name für die Ressource, der die Identifizierung in der API-Dokumentation erleichtert.
    Ressourcen werden nach ihren Anzeigenamen auf der linken Seite der Seite "API-Test" aufgelistet.
  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, d.h. den Ressourcentyp (resourcesType:). Sie müssen keinen Ressourcentyp angeben. Wenn Sie einen Ressourcentyp verwenden möchten, aber keinen definiert haben, klicken Sie auf den Link Typen, und definieren Sie einen Ressourcentyp.

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

Sie können die Unordnung aufheben, um eine Ressource schneller zu suchen, indem Sie in den Kompaktmodus wechseln (rechts neben Neue Ressource). Die kompakte Anzeige blendet die Ressourcenbeschreibung, den Ressourcentyp und den Pfad aus.

Methoden zu Ihren 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 oben auf der Seite klicken, um deren 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 ü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 den 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 ausgewählt haben, wird sie nicht mehr in der Methodenliste aufgeführt, da 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 definierte Methode angezeigt. Klicken Sie auf ein Methodensymbol, um direkt zu seiner Definition zu gelangen.

  3. (Optional) Geben Sie im Feld "Beschreibung" eine kurze Beschreibung der Methode ein.
  4. (Optional) Geben Sie einen Anzeigenamen für die Methode ein.
  5. (Optional) Geben Sie alle Eigenschaften an, die auf die Methode angewendet werden sollen.

    Wenn keine Ressourcenmerkmale definiert sind, klicken Sie auf Endpunkte, um zur Hauptseite "Ressourcen" zurückzukehren, und klicken Sie auf den Link Eigenschaften, um eine zu definieren. Mit Merkmalen 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.

Prozess für die Methode definieren

Nachdem Sie eine Methode ausgewählt haben, definieren Sie die Anforderung des Service, mit 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 an den Service zu sendenden Daten enthält.

  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 an.
    2. Wählen Sie einen gültigen Werttyp: 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 verfügen über eine Ressource (audits) und fügen einen Abfrageparameter (auditorID) hinzu, der einen Zahlenwert annimmt, sowie einen weiteren 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 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. Je nach ausgewählter Methode klicken Sie auf Medientyp hinzufügen, und definieren Sie den Methodentext. Der Body enthält die Daten, die Sie an den Server senden. Beispiel: Wenn Sie eine POST-Methode definieren, müssen Sie den Artikel definieren, den Sie erstellen, z.B. ein neues Kundenangebot oder eine Serviceanfrage. Wenn Sie eine GET-Methode definieren, müssen Sie keinen Methodenbody senden, damit Sie keinen Medientyp angeben müssen.
    1. Wählen Sie den Medientyp für Ihren Methodenbody aus. Dies ist das Format der Nachricht, die Sie senden, wie Text, Bilder oder Webformulare.
      Je nach Typ (Beispiel: Sie würden kein Schema für einen Imagetyp eingeben), können Sie ein Schema, ein Beispiel oder beides hinzufügen.

      Wenn Sie ein Schema definieren, 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 nur die Übertragung verlangsamen und möglicherweise das Fehlerpotenzial erhöhen.

    2. (Optional) Klicken Sie auf Schema, und geben Sie im Editorbereich ein Schema (im JSON-Format) ein. Ein Schema ist wie ein Template für den Body. Damit definieren Sie den Inhalt der Nachricht.
    3. (Optional) Klicken Sie auf Beispiel, und geben Sie im Editorbereich ein Beispiel (im JSON-Format) ein. Dieses wird von der Mock-Implementierung als Mock-Antwort für die Methode verwendet. Mit Mock-Daten können Sie das Verhalten Ihrer Methoden überprü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 weitere Medientypen hinzuzufügen. Wenn Sie die Methode nicht möchten, 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 zur Rückgabe von Ergebnissen aus dem Service. Sie können eine Antwort definieren, die überprüft, ob die von Ihnen angeforderten Daten zurückgegeben wurden, oder eine Antwort, die bestätigt, ob die Anforderung empfangen wurde. Das Definieren einer Antwort ähnelt dem Definieren einer Anforderung. Der Hauptunterschied besteht darin, dass Sie einen Statuscode auswählen müssen, um das Ergebnis der Verbindung anzuzeigen.

  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.

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

    • 2xx gibt an, dass eine erfolgreiche Verbindung hergestellt wurde.

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

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

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

    Um denjenigen zu helfen, der die API verwendet, um den Grund für einen potenziellen Fehler in der konfigurierten API zu verstehen, verwenden Sie einen HTTP-Statuscode, um Code zurückzugeben, der am besten mit der Fehlersituation übereinstimmt.

  3. Geben Sie eine Beschreibung des Codes an.
  4. Klicken Sie auf Header hinzufügen, wählen Sie einen Header oder eine Abfrage für die Antwort aus, 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 für den 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.
      Fügen Sie wie beim Anforderungsbody nur relevante Daten zum Antwortbody hinzu. Geben Sie nicht mehr Daten an, als Sie für den Vorgang tatsächlich benötigen.
    2. Klicken Sie auf Beispiel, um Mock-Daten (im JSON-Format) für Ihren Antwortbody hinzuzufügen. Mit Mock-Daten können Sie das Verhalten Ihrer Methoden vor dem Testen mit echten Daten prüfen.
    3. Klicken Sie für den formularbasierten Medientyp (z.B. multipart/form-data) auf Parameter hinzufügen, und wählen Sie Erforderlich aus, wenn der Parameter erforderlich ist. Geben Sie dann einen Namen an, und wählen Sie einen Werttyp aus. Optional können Sie Ihrem Parameter einen Namen geben.
    4. Bei bildbasierten Medientypen (z.B. image/png) müssen Sie nichts tun, weil keine Schemas oder Attribute angegeben werden müssen.
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 auch das Rückgabeantwortformat application/json, einen hinzugefügten Location-Header und den Nachrichtentext mit Mock-Daten:
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 Ihre 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 wechseln, um eine Root, Ressourcentypen oder Eigenschaften zu erstellen oder API-Dokumentation hinzuzufügen.

Wenn Sie die Methode nicht möchten, 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 grundlegende funktionierende Connector-API abzurufen, können Sie nur einen Namen für die Connector-API und eine URL für den externen Service angeben.

Von dort aus können Sie:

  • Definieren Sie Regeln, um bestimmte Anforderungen oder Antworten für die Daten zu bilden, 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 Verbindungsaufrufe.

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 funktionierenden Connector erstellen, indem Sie die ersten beiden Seiten im REST-Connector-API-Assistenten ausfüllen.

  1. Klicken Sie auf Seitenmenü-Symbol ö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 in der Dropdown-Liste die Option REST aus.

  3. Identifizieren Sie die neue REST-Connector-API, indem Sie Folgendes angeben:

    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. Die Basis-URI wird unter dem Feld API-Name angezeigt.

      Abgesehen von einer neuen Version dieser Connector-API kann keine andere Connector-API denselben Ressourcennamen aufweisen.

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

  4. Klicken Sie auf Create.

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

    • HTTP-Lesetimeout: Die maximale Zeit (in Millisekunden), die für das Warten auf das Lesen der Daten aufgewendet 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 aufgewendet wurde. Ein Wert von 0 mm bedeutet, dass ein unbegrenzter Timeout zulässig ist.

      Die HTTP-Timeoutwerte müssen kleiner als die Network_HttpRequestTimeout-Policy sein, die einen Standardwert von 40.000 ms aufweist.

      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 in der Administratoransicht anzuzeigen. Fragen Sie andernfalls den Mobile Cloud-Administrator nach den Werten.
  6. Klicken Sie auf Descriptor, 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:

    Es werden nur Standard-Internetzugangsports 80 und 443 unterstützt. 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 aus.

Von dort aus können Sie den Connector wie folgt weiter konfigurieren:

  • (Wenn Sie auf der Seite "Deskriptor" einen Deskriptor angegeben haben, gehen Sie zur Seite Ressourcen, und wählen Sie die Methoden für die bereitgestellten Ressourcen aus.

  • Regeln definieren.

  • Sicherheits-Policys festlegen.

Um sicherzustellen, dass die Connector-API-Konfiguration gültig ist, sollten Sie sie gründlich testen (nicht nur auf der Seite "Connector-API-Test"), bevor Sie sie veröffentlichen. Das heißt, Sie sollten 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 bereit sein, die benutzerdefinierte API zu veröffentlichen, die sie aufruft.

Regeln festlegen

Sie legen Regeln fest, um die Interaktionen zwischen Ihrer App und einem Service zu definieren. Mit Regeln können Sie Standardparameterwerte für alle Aufrufe von Ressourcen im Service, Aufrufe eines bestimmten Proxypfads und Aufrufe bestimmter Typen von Vorgängen (verbs) hinzufügen. Auf diese Weise wird eine konsistente Syntax der URL-Zeichenfolge erzwungen, der Entwickler von benutzerdefiniertem Code muss diese Werte nicht 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 über den Proxy an den vorhandenen Service übergeben.

  1. Wenn der Connector noch nicht geöffnet ist, klicken Sie auf Seitenmenüsymbol, und wählen Sie im Seitenmenü Entwicklung und dann APIs aus.
  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 Abfrage- oder Headernamen und seinen Wert ein.

    Hinweis:

    Obwohl 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 aufgerufen hat, oder indirekt, z.B. über einen Webbrowser oder eine mobile App, bereits dieselben Header festgelegt hat.

    Insbesondere wird das Festlegen des Formats des Anforderungstextes in der Regel im benutzerdefinierten Code mit dem Header Content-Type und nicht als REST-Connector-Regel ausgeführt. Ebenso wird das Festlegen des Formats des Antwortbodys auch im benutzerdefinierten Code mit dem Accept-Header und nicht als REST-Connector-Regel vorgenommen.

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

  6. Blenden Sie Ressourcen ein, und bearbeiten Sie die Remote-URL, um eine Ressource für die anzuwendende Regel bereitzustellen. Der Basis-URL-Wert ist der Wert, den Sie im Schritt "Basisinformationen festlegen" eingegeben haben und der nicht bearbeitet werden kann.
  7. Wählen Sie Nicht auf Ressourcen niedrigerer Ebene anwenden aus, 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 gerade definierte Regeln angewendet werden sollen. 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 widersprüchliche Regel wird ignoriert.

    Klicken Sie anschließend auf Speichern und dann auf Weiter (>), um zum nächsten Schritt bei der Konfiguration der Connector-API zu gehen.

Die Beschreibung der soeben definierten Regel wird im Banner Regel direkt über dem Abschnitt Standardparameter angezeigt. Angenommen, es wurden die folgenden Werte 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 lautet wie folgt:

Um GET bis https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle unter myMapAPI/directions verfügbar zu machen, nehmen Sie Query:key=A3FAEAJ903022 auf.

Wenn keine Regeln erstellt wurden, lautet die Beschreibung wie folgt:

Für ALL METHODS to 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 ist 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 überlegen, wie Sie mit ihrer Sicherheit umgehen. Sie können entweder Sicherheits-Policys oder Autorisierungsheader verwenden. Es wird empfohlen, eine Sicherheits-Policy auszuwählen, die das Authentifizierungsschema des Service beschreibt, mit dem Sie eine Verbindung herstellen.

Jede Sicherheits-Policy verfügt über Eigenschaften, sogenannte Overrides, die Sie konfigurieren können. Ein Grund zum Überschreiben einer Policy-Konfigurationseigenschaft besteht darin, die Anzahl der Policys einzuschränken, die Sie verwalten müssen. Anstatt mehrere Policys mit leicht unterschiedlichen Konfigurationen zu erstellen, können Sie dieselbe generische 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 Seitenmenüsymbol, und wählen Sie im Seitenmenü Entwicklung, APIs 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 aus, und klicken Sie auf den Pfeil nach rechts, um sie in die Liste Ausgewählte Policys zu verschieben.
    Wählen Sie nur eine einzelne Policy für die Connector-API aus. Unter der Liste wird eine Beschreibung einer ausgewä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 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 REST-Connector-API-Assistenten zu beenden.
  7. Klicken Sie auf Weiter (>), um mit dem nächsten Schritt fortzufahren.