Tutorial: JSON-Inhalte zuordnen

Online bearbeiten

In diesem Tutorial lernen Sie, wie Sie Nachrichteninhalte von einem Format oder Schema auf ein anderes Format oder Schema abbilden können.

Vorbereitende Schritte

Diese Task kann von Benutzern ausgeführt werden, denen eine der folgenden Rollen zugewiesen ist:

Katalogeigner
Entwickler

Hinweis: Der Sandbox-Katalog muss so konfiguriert sein, dass er entweder ein DataPower® Gateway (v5 compatible) oder ein DataPower API Gateway oder beides verwendet. Siehe „Erstellen und Konfigurieren von Katalogen “.

Info zu diesem Tutorial

In diesem Tutorial nehmen Sie die folgenden Lerneinheiten durch:

Neue API erstellen
JSON-Inhalt zuordnen

Neue API erstellen

Führen Sie die folgenden Schritte aus, um eine neue API zu erstellen.

Melden Sie sich bei API Manager an.
Klicken Sie auf der Startseite auf die Kachel APIs und Produkte entwickeln.
Alternativ können Sie auch auf das Symbol " Entwickeln" im linken Fensterbereich klicken.
Klicken Sie auf der Seite „Entwickeln“ auf „Hinzufügen“ > „API “.
Auf der Seite API-Typ auswählen,
1. Stellen Sie sicher, dass OpenAPI 2.0 ausgewählt ist.
2. Wählen Sie das Optionsfeld Neu OpenAPI.
3. Klicken Sie auf Weiter.
Geben Sie auf der Seite " Create new OpenAPI " die folgenden Informationen über die API ein.
Hinweis: Das Feld OpenAPI Version ist vordefiniert. Sie können dieses Feld nicht aktualisieren.
1. Geben Sie in das Feld Titel Mapper ein.
  Das Feld Name wird mit dem Wert gefüllt, den Sie in das Feld Titel eingeben.
2. Geben Sie in das Feld Version 1.0.0 ein.
3. Geben Sie in das Feld Basispfad /map ein.
4. Klicken Sie auf Weiter.
Unter dem Abschnitt Sicher,
1. Die Kontrollkästchen „Mit Client-ID sichern“ und „ CORS “ sind bereits aktiviert. Deaktivieren Sie die Kontrollkästchen nicht.
2. Klicken Sie auf Weiter.
  Sie sehen den Fortschritt bei der Erstellung der neuen API. Wenn die API erstellt ist, wird eine Zusammenfassung angezeigt.
Klicken Sie unter dem Abschnitt Zusammenfassung auf API bearbeiten.
Die Registerkarte Entwurf für den Entwurf Ihrer API-Definition wird angezeigt.
Klicken Sie im linken Bereich auf Verbrauchen.
In der rechten Leiste, im Abschnitt Verbrauchen,
1. Klicken Sie auf Hinzufügen +.
2. Wählen Sie im Dialogfeld Schema hinzufügen aus der Dropdown-Liste Mime-Typ (optional) die Option application/json und klicken Sie dann auf Hinzufügen.
Klicken Sie im linken Bereich auf Produzieren.
In der rechten Leiste, im Abschnitt Produziert,
1. Klicken Sie auf Hinzufügen +.
2. Wählen Sie im Dialogfeld Schema hinzufügen aus der Dropdown-Liste Mime-Typ (optional) die Option application/json und klicken Sie dann auf Hinzufügen.
Klicken Sie im linken Bereich auf Pfade.
In der rechten Leiste, im Abschnitt Pfade,
1. Klicken Sie auf Hinzufügen +.
2. Geben Sie in das Feld Pfadname /jsonmap ein und klicken Sie dann auf Hinzufügen.
Klicken Sie im linken Bereich unter dem neu erstellten Pfad (/jsonmap ) neben Operationen auf das Symbol +.
Das Dialogfeld Schema hinzufügen wird angezeigt.
Führen Sie im Dialogfeld Schema hinzufügen die folgenden Aufgaben aus.
1. Geben Sie in das Feld Verb(Schlüssel) (optional) get ein.
2. Geben Sie im Feld Operation (optional) POST ein.
3. Klicken Sie auf Hinzufügen.
Klicken Sie im linken Bereich neben Parameter auf das Symbol +.
Das Dialogfeld Schema hinzufügen wird angezeigt.
Führen Sie im Dialogfeld Schema hinzufügen die folgenden Aufgaben aus.
1. Geben Sie in das Feld Name body ein.
2. Aktivieren Sie das Kontrollkästchen Erforderlich.
3. Wählen Sie in der Dropdown-Liste Erreichbar in body.
4. Klicken Sie auf Hinzufügen.
Blättern Sie nach unten zum Abschnitt Schema und klicken Sie dann auf Anzeigen.
Führen Sie unter dem Abschnitt Schema die folgenden Aufgaben aus.
1. Geben Sie im Feld Titel (optional) body ein.
2. Wählen Sie in der Dropdown-Liste Typ die Option Zeichenfolge.
3. Klicken Sie in der oberen rechten Ecke auf Speichern.
Erweitern Sie im linken Bereich „Pfade“ > „Operationen “ > „Reaktionen “.
Klicken Sie unter Antworten auf 200.
Führen Sie auf der rechten Seite unter dem Abschnitt 200 die folgenden Aufgaben aus.
1. Geben Sie im Feld Name (Schlüssel) 200 ein.
2. Geben Sie in das Feld Beschreibung 200 OK ein.
3. Klicken Sie in der oberen rechten Ecke auf Speichern.

JSON-Inhalt zuordnen

Klicken Sie auf die Registerkarte Gateway.
Löschen Sie die vorhandene Richtlinie auf der Arbeitsfläche, indem Sie den Mauszeiger über die Richtlinie bewegen und dann auf das Lösch symbol klicken .
Hinweis: Wenn Sie DataPower API Gateway verwenden, handelt es sich um eine Aufforderungsrichtlinie, während Sie DataPower Gateway (v5 compatible) verwenden, ist die Richtlinie eine Proxy-Richtlinie.
Um die Palette anzuzeigen, klicken Sie im rechten Bereich auf das Plus-Symbol .
Wählen Sie unter der Spalte Transformationen die Option Karte.
Der Kartenrichtlinienknoten wird auf der Arbeitsfläche angezeigt.
Klicken Sie auf den Knoten der Zuordnungsrichtlinie, um das Konfigurationsdialogfeld zu öffnen.
Klicken Sie neben „Eingabe “ auf das Symbol „Eingaben bearbeiten “.
Klicken Sie auf Eingabe hinzufügen.
Vervollständigen Sie die Konfiguration der Karteneingabe, indem Sie die folgenden Werte eingeben
1. Geben Sie in das Feld Kontextvariable request.body ein.
2. Geben Sie in das Feld Name input ein.
3. Wählen Sie in der Dropdown-Liste Inhaltstyp die Option application/json.
4. Wählen Sie aus der Dropdown-Liste Definition die Option Inline schema.
  Das Pop-up-Fenster Schema bereitstellen wird angezeigt.
5. Führen Sie im Popup-Fenster Provide a schema die folgenden Aufgaben aus.
  1. Wählen Sie die Registerkarte Aus JSON-Beispiel generieren.
  2. Fügen Sie das folgende JSON-Beispiel in das Feld ein.
```
{"order":
{"customer":
{"name":
{
"firstname":"John",
"middlename":"Q",
"lastname":"Smith"
},
"address":
{
"line1":"550 King St",
"line2":"Dept 5",
"city":"Littleton",
"state":"MA",
"country":"USA",
"code":"01460"
}
}
},
"items":
[{"item":"shoes", "color":"black", "qty":2, "price":23.50},
{"item":"socks", "color":"argyle", "qty":2, "price":3.95},
{"item":"pants", "color":"grey", "qty":1, "price":48.00}]
}
```
  3. Klicken Sie auf Erzeugen.
  4. Klicken Sie auf Done.
    Das Pop-up-Fenster ist nun geschlossen.
6. Klicken Sie im Dialogfeld für die Konfiguration der Kartenrichtlinie auf Fertig, um die Konfiguration der Karte abzuschließen.
Klicken Sie neben der Spalte „Ausgabe“ auf das Symbol „Ausgaben bearbeiten“.
Klicken Sie auf Ausgabe hinzufügen.
Vervollständigen Sie die Konfiguration der Kartenausgabe, indem Sie die folgenden Werte eingeben
1. Geben Sie in das Feld Kontextvariable message.body ein.
2. Geben Sie in das Feld Name output ein.
3. Wählen Sie in der Dropdown-Liste Inhaltstyp die Option application/json.
4. Wählen Sie aus der Dropdown-Liste Definition die Option Inline schema.
  Das Pop-up-Fenster Schema bereitstellen wird angezeigt.
5. Führen Sie im Popup-Fenster Provide a schema die folgenden Aufgaben aus.
  1. Wählen Sie die Registerkarte Aus JSON-Beispiel generieren.
  2. Fügen Sie das folgende JSON-Beispiel in das Feld ein.
```
{"order":
{
"date":"12-12-12",
"customer": "John Smith",
"address":
{
"street":"king",
"citystatezip":"lit MA 01469",
"country":"USA"
},
"items":[{"type":"shoes", "color":"black", "qty":2, "price":23.50}]
}
}
```
  3. Klicken Sie auf Erzeugen.
6. Klicken Sie auf Done.
  Das Pop-up-Fenster ist nun geschlossen.
7. Klicken Sie im Dialogfeld für die Konfiguration der Kartenrichtlinie auf Fertig, um die Konfiguration der Karte abzuschließen.
Klicken Sie auf Speichern.
Führen Sie im Fenster zur Konfiguration der Kartenausgabe in der Spalte Ausgabe die folgende Aufgabe aus.
1. Wählen Sie das Optionsfeld Datum.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Geben Sie im Dialogfeld " Zuordnung konfigurieren " das folgende Beispiel ein: JavaScript.
    new Date().toGMTString()
  2. Klicken Sie auf Done.
2. Wählen Sie in der Spalte Eingabe das Optionsfeld Vorname und dann in der Spalte Ausgabe das Optionsfeld Kunde.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
3. Wählen Sie in der Spalte Eingabe das Optionsfeld middlename und dann in der Spalte Ausgabe das Optionsfeld customer.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
4. Wählen Sie unter der Spalte Eingabe das Optionsfeld Nachname und dann unter der Spalte Ausgabe das Optionsfeld Kunde.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
5. Wählen Sie in der Spalte Ausgabe das Optionsfeld Kunde.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Geben Sie im Dialogfeld " Zuordnung konfigurieren " in das Feld " Wert" den folgenden Beispielcode ein.
```
var name = $(input.order.customer.name.firstname) + ' '; 
  if($(input.order.customer.name.middlename)) {
  name += $(input.order.customer.name.middlename) + ' ';}
  name += $(input.order.customer.name.lastname);
  name
```
  2. Klicken Sie auf Done.
6. Wählen Sie in der Spalte „Eingabe “ das Optionsfeld „Adresse > line1 “ aus und anschließend in der Spalte „Ausgabe “ das Optionsfeld „Straße “.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
7. Wählen Sie in der Spalte „Eingabe “ das Optionsfeld „Adresse > line2 “ aus und anschließend in der Spalte „Ausgabe “ das Optionsfeld „Straße “.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
8. Wählen Sie in der Spalte Ausgabe das Optionsfeld Straße.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Geben Sie im Dialogfeld " Zuordnung konfigurieren " in das Feld " Wert" den folgenden Beispielcode ein.
```
var street = $(input.order.customer.address.line1) + ' '; 
  if($(input.order.customer.address.line2)) {
  street += $(input.order.customer.address.line2);}
  street
```
  2. Klicken Sie auf Done.
9. Wählen Sie in der Spalte Eingabe das Optionsfeld Stadt und dann in der Spalte Ausgabe das Optionsfeld Stadt-Zahl.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
10. Wählen Sie in der Spalte Eingabe das Optionsfeld Bundesland und dann in der Spalte Ausgabe das Optionsfeld StadtStaatZip.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
11. Wählen Sie in der Spalte Eingabe das Optionsfeld Code und dann in der Spalte Ausgabe das Optionsfeld citystatezip aus.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
12. Wählen Sie in der Spalte Ausgabe das Optionsfeld Straße.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Geben Sie im Dialogfeld " Zuordnung konfigurieren " in das Feld " Wert" den folgenden Beispielcode ein.
```
$(1) + " " + $(2) + " " + $(3)
```
    Hinweis: Die Variablenverweise sind positionsbezogen; $(1) bezieht sich auf den ersten zugeordneten Wert (input.order.customer.city) usw.
  2. Klicken Sie auf Done.
13. Wählen Sie in der Spalte „Eingabe “ das Optionsfeld „Elemente > Element “ aus und anschließend in der Spalte „Ausgabe “ das Optionsfeld „Elemente “.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Aktivieren Sie im Dialogfeld Zuordnung konfigurieren das Kontrollkästchen Leere Zeichenfolge als Standardwert.
  2. Klicken Sie auf Done.
14. Klicken Sie unter der Spalte Ausgabe auf die zweite Eigenschaft hinzufügen.
  1. Geben Sie in das erste Feld total ein.
  2. Wählen Sie aus der Dropdown-Liste float.
  3. Klicken Sie auf das Symbol +.
15. Wählen Sie in der Spalte Eingabe das Optionsfeld Artikel und dann in der Spalte Ausgabe das Optionsfeld Summe.
  Das Dialogfeld Zuordnung konfigurieren wird angezeigt.
  1. Geben Sie im Dialogfeld " Zuordnung konfigurieren " in das Feld " Wert" den folgenden Beispielcode ein.
```
$(0) + ($(input.items.price) * $(input.items.qty))
```
  2. Klicken Sie auf Done.
16. Klicken Sie auf der Ausgabeseite des Kartenrichtlinienknotens auf Speichern.
Quelle anklicken.
Blättern Sie nach unten und suchen Sie den Code, in dem die Gesamtsumme berechnet wird.
Fügen Sie eine neue Zeile mit dem Code foreach: input.items ein.
Klicken Sie auf Speichern.

API-Definition testen

Hinweis: Aufgrund von Einschränkungen beim Cross-Origin Resource Sharing ( CORS ) kann das Assembly-Test-Tool nicht mit den Browsern Chrome oder Safari auf der Plattform „ macOS “ Catalina verwendet werden.

Um Ihre API-Definition mit dem API-Manager-Testtool zu testen, führen Sie die folgenden Schritte aus:

Klicken Sie auf die Schaltfläche Assemble.
Klicken Sie auf das Symbol „Test “. Das Testtool wird geöffnet.
Klicken Sie auf API aktivieren.
Im Feld Operation wählen Sie post /jsonmap.

Geben Sie in das Feld Hauptteil den folgenden JSON-Text ein.

{"order":
{"customer":
{"name":
{
"firstname":"John",
"middlename":"Q",
"lastname":"Smith"
},
"address":
{
"line1":"550 King St",
"line2":"Dept 5",
"city":"Littleton",
"state":"MA",
"country":"USA",
"code":"01460"
}
}
},
"items":
[{"item":"shoes", "color":"black", "qty":2, "price":23.50},
{"item":"socks", "color":"argyle", "qty":2, "price":3.95},
{"item":"pants", "color":"grey", "qty":1, "price":48.00}]
}

Test wählen op

Klicken Sie auf Aufrufen. Die Antwort wird angezeigt. Beachten Sie, dass die Werte der Felder date, street, citystatezip und total die Zuordnungsformeln widerspiegeln, die Sie zuvor definiert haben.
Hinweis: Wenn Sie ein selbstsigniertes Zertifikat verwenden, werden Sie möglicherweise aufgefordert, ein bereitgestelltes URL zu besuchen. Klicken Sie auf den Link und akzeptieren Sie dann das Zertifikat, bevor Sie zum API-Manager zurückkehren und erneut auf Aufrufen klicken.

Verwalten Ihrer API-Definition

Da Ihre neue API nun wie erwartet funktioniert, können Sie mit ihrer Verwaltung beginnen. Führen Sie die folgenden Schritte aus, um Ihre unmittelbaren Optionen zu sehen.

Klicken Sie im Navigationsbereich auf das Symbol „Entwickeln “.
Klicken Sie neben der Mapper -API auf das Men üsymbol und wählen Sie dann „Herunterladen“ aus.

Die Themen dieses Tutorials

Erstellen einer neuen API
Inhalte, die aus einem JSON-Schema einem anderen Schema zugeordnet wurden.