Eine Postman-Sammlung für einen benutzerdefinierten Konnektor erstellen

Postman ist eine Anwendung zum Erstellen von HTTP-Anfragen, und Postman Sammlungen helfen Ihnen, verwandte API-Anfragen zu organisieren und zu gruppieren. Sammlungen können die Entwicklung benutzerdefinierter Konnektoren beschleunigen und vereinfachen, wenn keine OpenAPI-Definition für die API bereits vorhanden ist. Weitere Informationen über Sammlungen finden Sie unter Erstellen von Sammlungen in der Postman-Dokumentation.

In diesem Thema erstellen Sie eine Sammlung, die eine Anforderung und Antwort von der Textanalyse-API von Azure Cognitive Services enthält. In einem verwandten Thema erstellen Sie einen Konnektor unter Verwendung dieser Sammlung.

Anforderungen

• Die Postmann Anwendung
• Ein API-Schlüssel für die Cognitive Services-API zur Textanalyse

Eine HTTP-Anforderung für die API erstellen

1. Wählen Sie in Postman auf der Registerkarte Builder die HTTP-Methode, geben Sie die Anfrage-URL für den API-Endpunkt ein und wählen Sie gegebenenfalls ein Autorisierungsprotokoll.

   

   Parameter	Wert
   HTTP-Methode	NACHRICHT
   URL anfordern	https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment
   Autorisierung	„No Auth“ (Keine Authentifizierung; Sie geben im nächsten Schritt einen API-Schlüssel ein)

2. Geben Sie Schlüssel-Wert-Paare für den Anforderungsheader ein. Für allgemeine HTTP-Header können Sie aus der Dropdown-Liste wählen.

   

   Key	Wert
   Ocp-Apim-Subscription-Key	Ihr-API-Abonnementschlüssel, den Sie in Ihrem Cognitive Services-Konto finden.
   Inhaltsart	application/json

3. Geben Sie Inhalt ein, der im Anforderungstext gesendet werden soll. Wählen Sie Senden aus, um anhand einer Antwort zu prüfen, ob die Anforderung funktioniert.

   

   {
       "documents": [{
           "language": "en-us",
           "id": "1", 
           "text": "I enjoyed the new movie after a long day."
       }]
   }
   

   Das Antwortfeld enthält die vollständige Antwort der API, einschließlich des Ergebnisses oder, falls zutreffend, eines Fehlers.

   

Weitere Informationen über HTTP-Anforderungen finden Sie unter Anforderungen in der Postmann-Dokumentation.

Sammlung speichern

1. Wählen Sie Save (Speichern).

   

2. Geben Sie im Dialog Save request einen Anforderungsnamen und eine Beschreibung ein. Der benutzerdefinierte Konnektor verwendet diese Werte für die Zusammenfassung und die Beschreibung des API-Vorgangs.

   

   Parameter	Wert
   Anforderungsname	DetectSentiment
   Anforderungsbeschreibung	Die API gibt einen numerischen Wert zwischen 0 und 1 zurück. Werte nahe 1 zeigen eine positive Stimmung an, Werte nahe 0 zeigen eine negative Stimmung an.

3. Wählen Sie + Create Collection aus, und geben Sie einen Namen für die Sammlung ein. Der benutzerdefinierte Konnektor verwendet diesen Wert, wenn Sie die API aufrufen. Wählen Sie das Häkchen (✓), wodurch ein Sammelordner erstellt wird, und wählen Sie dann Save to SentimentDemo aus.

   

   Parameter	Wert
   Sammlungsname	SentimentDemo

Anforderungsantwort speichern

Wenn Sie Ihre Anforderung gespeichert haben, können Sie auch die Antwort speichern. Auf diese Weise wird die Antwort als Beispiel angezeigt, wenn Sie die Anforderung später laden.

1. Wählen Sie oberhalb des Antwortfensters Antwort speichern aus.

   

   Benutzerdefinierte Konnektoren unterstützen nur eine Antwort pro Anforderung. Wenn Sie mehrere Antworten pro Anforderung speichern, wird nur die erste Antwort verwendet.

2. Geben Sie oben in der App einen Namen für Ihre Beispielantwort ein, und wählen Sie dann Save Example aus.

   

Wenn Ihre API über zusätzliche Funktionen verfügt, können Sie fortfahren, Ihre Postman-Sammlung mit zusätzlichen Anforderungen und Antworten zu erstellen.

Postman-Sammlung exportieren

Sie exportieren nun die Sammlung als JSON-Datei, die Sie mit dem Assistenten für benutzerdefinierte Connectors importieren. Bevor Sie die Sammlung exportieren, entfernen Sie den Inhaltstyp und die Sicherheitskopfzeilen—diese waren für die Erstellung von API-Anforderungen erforderlich, werden aber im benutzerdefinierten Connector anders gehandhabt.

1. Zeigen Sie auf der Registerkarte Header auf die einzelnen Header, und wählen Sie neben den Headern zum Entfernen jeweils das X aus. Wählen Sie Speichern aus, um die Sammlung erneut zu speichern.

   

2. Wählen Sie die Auslassungspunkte (…) neben der Sammlung und dann Export aus.

   

3. Wählen Sie das Exportformat Collection v1 aus, wählen Sie Export aus, und navigieren Sie dann zum Speicherort, an dem Sie die JSON-Datei speichern möchten.

   

   Hinweis

   Derzeit können Sie für benutzerdefinierte Konnektoren nur v1-Sammlungen verwenden.

Nächste Schritte,

Sie sind jetzt bereit, einen benutzerdefinierten Konnektor auf der Grundlage der von Ihnen erstellten Postman-Sammlung zu definieren:

• Einen benutzerdefinierten Connector auf der Grundlage einer Postman-Sammlung erstellen

Feedback senden

Wir freuen uns sehr über Feedback zu Problemen mit unserer Connector-Plattform oder neuen Feature-Ideen. Wenn Sie Feedback geben möchten, gehen Sie zu Probleme melden oder Hilfe zu Connectors und wählen Sie einen Feedbacktyp aus.