Übung – OpenAPI-Erweiterungen verwenden

  • 8 Minuten

In dieser Übung konfigurieren Sie OpenAPI I-Erweiterungen im benutzerdefinierten Konnektor für Contoso Invoicing. Sie implementieren die folgenden Erweiterungen:

  • Testverbindung – Um zu überprüfen, ob der eingegebene API-Schlüssel gültig ist

  • Dynamische Werte – Eine Dropdownliste mit Werten aus der API zur Eingabe einer Rechnungstyp-ID

  • Dynamisches Schema – Um nur die Parameter anzuzeigen, die für den ausgewählten Rechnungstyp gültig sind

Wichtig

Verwenden Sie eine Testumgebung mit bereitgestelltem Microsoft Dataverse. Wenn Sie keine haben, können Sie sich für den Community-Plan anmelden.

Hinweis

Laden Sie die folgende Datei auf Ihren lokalen Computer herunter, um diese Übung Contoso Invoicing Triggers abzuschließen. Wählen Sie die Schaltfläche „Herunterladen“ im mittleren rechten Teil des Bildschirms aus.

Aufgabe 1: Eine Lösung importieren

In dieser Aufgabe importieren Sie eine nicht verwaltete Lösung, die einen benutzerdefinierten Konnektor für Contoso Invoicing enthält, und testen dann den Konnektor. Sie verwenden diesen Konnektor, um die Aufgaben in dieser Übung abzuschließen.

  1. Navigieren Sie zum Power Apps Maker Portal, und stellen Sie sicher, dass Sie sich in der richtigen Umgebung befinden.

  2. Wählen Sie Lösungen > Lösung importieren aus.

  3. Wählen Sie Durchsuchen aus.

  4. Wählen Sie die Lösung ContosoInvoicingExtensions_1_0_0_0.zip und dann Öffnen aus.

  5. Wählen Sie Weiter aus.

  6. Wählen Sie Importieren aus, und warten Sie dann, bis der Import abgeschlossen ist. Nach Abschluss des Imports sollte eine Erfolgsmeldung angezeigt werden.

  7. Wählen Sie Alle Anpassungen veröffentlichen aus, und warten Sie dann, bis die Veröffentlichung abgeschlossen ist.

  8. Öffnen Sie die Lösung Contoso Invoicing ‑ Extensions, die Sie importiert haben.

    Ihnen sollte die benutzerdefinierte Konnektorkomponente Contoso Invoicing – Erweiterungen angezeigt werden.

  9. Wählen Sie den Konnektor Contoso Invoicing ‑ Extensions und dann Bearbeiten aus.

    Screenshot eines Pfeils, der auf die Schaltfläche „Lösung bearbeiten“ verweist

  10. Öffnen Sie ein neues Browserfenster, und gehen Sie dann zu Contoso Invoicing.

  11. Wählen Sie den Link API-Schlüssel aus.

  12. Kopieren Sie den API-Schlüssel. Speichern Sie diesen Schlüssel in einem Editor. Sie benötigen ihn für zukünftige Aufgaben.

  13. Kehren Sie zum Konnektor zurück, wählen Sie die Registerkarte Testen und dann + Neue Verbindung aus.

    Screenshot der Schaltfläche „Neue Verbindung hinzufügen“

  14. Fügen Sie den Schlüssel ein, den Sie in das Feld API-Schlüssel kopiert haben, und wählen Sie dann Verbindung erstellen aus.

  15. Wählen Sie Verbindungen aktualisieren aus.

  16. Scrollen Sie nach unten zum Abschnitt Vorgänge, wählen Sie ListInvoiceTypes und dann Vorgang testen aus.

    Screenshot eines Pfeils, der auf die Schaltfläche „Vorgang testen“ verweist

    Sie sollten eine Antwort mit Rechnungstypen erhalten. Später verwenden Sie diese Operation, um die Erweiterung Dynamische Werte für den Parameter Rechnungstyp zu implementieren.

    Screenshot des angezeigten Inhalts des Antworttextes

  17. Navigieren Sie nicht von dieser Seite weg.

Aufgabe 2: Die Erweiterung „Verbindung testen“ hinzufügen

In dieser Aufgabe fügen Sie die Erweiterung „Verbindung testen“ hinzu:

  1. Bewegen Sie die Umschalttaste Swagger-Editor in die Position Ein.

    Screenshot der Umschalttaste zum Einschalten des Swagger-Editors

  2. Fügen Sie das folgende Fragment hinter produces: []hinzu, und wählen Sie dann Konnektor aktualisieren aus. Stellen Sie sicher, dass der Texteinzug mit dem folgenden Bild übereinstimmt.

    x-ms-capabilities:
   testConnection:
     operationId: ListInvoices
     parameters: {}

    Stellen Sie sicher, dass die Einrückung wie im Bild unten aussieht.

    Screenshot eines Pfeils, der auf die Schaltfläche „Konnektor aktualisieren“ verweist

  3. Wählen Sie erneut + Neue Verbindung aus.

    Screenshot eines Pfeils, der auf die Schaltfläche „Neue Verbindung hinzufügen“ verweist

  4. Geben Sie Ihren Namen oder einen anderen zufälligen Wert für einen API-Schlüssel ein, und wählen Sie dann Verbindung erstellen aus.

    Das Herstellen der Verbindung sollte fehlschlagen.

    Screenshot der Nachricht über die fehlgeschlagene Verbindung

  5. Geben Sie den API-Schlüssel an, den Sie in Aufgabe 1 in das Feld API-Schlüssel kopiert haben, und wählen Sie dann Verbindung erstellen aus.

    Das Herstellen der Verbindung sollte nun funktionieren.

  6. Navigieren Sie nicht von dieser Seite weg.

Aufgabe 3: Dynamische Werte für die Rechnungstyp-ID konfigurieren

In dieser Aufgabe konfigurieren Sie dynamische Werte für die Rechnungstyp-ID:

  1. Wählen Sie die Registerkarte Definition aus.

  2. Wählen Sie AddInvoice im Abschnitt Aktionen aus.

  3. Scrollen Sie nach unten, wählen Sie die Auslassungspunkte (Chevron) des Parameters typeId und dann Bearbeiten aus.

    Screenshot eines Pfeils, der auf die Schaltfläche „Abfrageparameter bearbeiten“ verweist

  4. Geben Sie Rechnungstyp für Zusammenfassung und 1 für Standardwert ein. Wählen Sie dann Ja für Ist erforderlich aus.

    Screenshot der Eigenschaften des Abfrageparameters

  5. Scrollen Sie nach unten, und wählen Sie Dynamisch für Dropdowntyp aus.

  6. Wählen Sie ListInvoiceTypes für Vorgangs-ID, typeId für Wert und dann Name für Wert – Anzeigename aus.

    Screenshot der Eigenschaften des Abfrageparameters

  7. Wählen Sie Konnektor aktualisieren aus.

  8. Bewegen Sie die Umschalttaste Swagger-Editor in die Position Ein.

  9. Wenn Sie Hash-Schlüsselfehler erhalten, schließen Sie die Registerkarte des Konnektor-Browsers und öffnen Sie sie erneut im Bearbeitungsmodus.

  10. Suchen Sie „AddInvoice“, und prüfen Sie, ob x-ms-dynamic-values hinzugefügt wurde.

    Screenshot der hinzugefügten dynamischen Werte

  11. Navigieren Sie nicht von dieser Seite weg.

Aufgabe 4: Die dynamische Schemaerweiterung konfigurieren

In dieser Aufgabe konfigurieren Sie die dynamische Schemaerweiterung:

  1. Wählen Sie die Registerkarte Testen aus.

  2. Wählen Sie den Vorgang GetInvoiceSchema und dann Vorgang testen aus.

    Screenshot eines Pfeils, der auf die Schaltflächen „GetInvoiceSchema“ und „Vorgang testen“ verweist

  3. Überprüfen Sie die Antwort. Diese Antwort muss eine API zurückgeben, damit Dynamisches Schema konfiguriert werden kann.

    Screenshot der Antwort „GetInvoiceSchema“

  4. Bewegen Sie die Umschalttaste Swagger-Editor in die Position Ein.

  5. Suchen Sie die Zeile CreateInvoiceRequest, und ersetzen Sie die Zeile Rechnung mit dem folgenden Swagger-Text.

    Rechnung:

    x-ms-dynamic-properties:

    operationId: GetInvoiceSchema

    parameters:

    typeId: {parameterReference: typeId}

    Vorher:

    Screenshot des Swagger-Texts vor der Bearbeitung

    Nachher:

    Stellen Sie sicher, dass die Einzüge mit dem folgenden Bild übereinstimmen.

    Screenshot des Swagger-Texts nach der Bearbeitung

  6. Bewegen Sie die Umschalttaste Swagger-Editor in die Position Aus.

  7. Wählen Sie die Registerkarte Definition aus.

  8. Wählen Sie die Aktion GetInvoiceSchema und dann Intern für Sichtbarkeit aus.

    Screenshot zur Sichtbarkeit der Antwort „GetInvoiceSchema“

  9. Wählen Sie Konnektor aktualisieren aus.

Aufgabe 5: Konnektor testen

In dieser Aufgabe testen Sie den Konnektor:

  1. Wechseln Sie zu Power Automate, und stellen Sie sicher, dass Sie sich in der richtigen Umgebung befinden.

  2. Wählen Sie Lösungen aus, und öffnen Sie dann die Lösung Contoso Invoicing ‑ Extensions.

  3. Klicken Sie auf + Neu, und wählen Sie dann Automatisierung > Cloud-Flow > Sofort aus.

    Screenshot eines Pfeils, der auf die Schaltfläche „Neuen Cloud-Flow erstellen“ verweist

  4. Geben Sie Dynamische Metadaten und Flowname ein, wählen Sie als Trigger Flow manuell ausgelöst und dann Erstellen aus.

  5. Wählen Sie+ Neuer Schritt aus.

  6. Wählen Sie die Registerkarte Benutzerdefiniert und dann Contoso Invoicing ‑ Extensions aus.

  7. Wählen Sie AddInvoice für die Aktion aus.

  8. Geben Sie Meine Verbindungen für den Namen ein, geben Sie Ihren Namen für den API-Schlüssel ein, und wählen Sie dann Erstellen aus. Der Verbindungstest sollte fehlschlagen.

Screenshot eines Pfeils, der auf den benutzerdefinierten Konnektor verweist

  1. Geben Sie den API-Schlüssel an, den Sie in Aufgabe 1 in das Feld API-Schlüssel kopiert haben, und wählen Sie dann erneut Erstellen aus.

    Die Verbindung sollte erfolgreich erstellt werden.

  2. Wählen Sie im Dropdownmenü Rechnungstyp Einkaufsbestellung aus.

    Screenshot eines Pfeils, der auf den Rechnungstyp „Einkaufsbestellung“ verweist

    Das Feld Einkaufsbestellung sollte jetzt sichtbar sein.

    Screenshot der benutzerdefinierten Konnektoraktion mit sichtbarem Feld „Einkaufsbestellung“

  3. Ändern Sie den Rechnungstyp in Keine Bestellung.

    Das Feld Einkaufsbestellung sollte nicht länger sichtbar sein.

    Screenshot der benutzerdefinierten Konnektoraktion mit ausgeblendetem Feld „Einkaufsbestellung“

  4. Speichern Sie den Flow.