Wie erstelle ich eine Sammlung in Postman

Postman ist ein beliebtes Tool zum Testen und Entwickeln von APIs. Eine seiner Hauptfunktionen ist die Möglichkeit, Abfragesammlungen zu erstellen und zu organisieren. Sammlungen sind eine bequeme Möglichkeit, Abfragen zu gruppieren und zu dokumentieren, sodass Sie Ihre API-Container einfach verwalten können.

Um eine Sammlung in Postman zu erstellen, müssen Sie die einfachen Schritte verwenden. Öffnen Sie zuerst die App und wählen Sie oben links die Registerkarte Sammlungen aus. Klicken Sie dann auf die Schaltfläche "Sammlung erstellen" und geben Sie einen Namen und eine Beschreibung der Sammlung an. Sie können auch Tags hinzufügen, um die Sammlung später einfacher zu finden.

Nachdem Sie die Sammlung erstellt haben, können Sie mit dem Hinzufügen von Abfragen beginnen. Tippen Sie auf die Sammlung auf der linken Seite des Bildschirms, um sie zu öffnen. Klicken Sie dann auf die Schaltfläche "Anfrage hinzufügen" und geben Sie einen Namen, eine URL und eine Beschreibung ein. Sie können bei Bedarf auch eine Abfragemethode, Header, Parameter und den Abfragetext angeben.

Schritt 1: Starten Sie den Postman

Um mit dem Erstellen einer Sammlung in Postman zu beginnen, müssen Sie das Programm ausführen. Postman kann auf verschiedenen Betriebssystemen wie Windows, macOS und Linux installiert werden.

Nach der Installation und dem Ausführen von Postman wird das Hauptfenster des Programms geöffnet. Hier sehen Sie verschiedene Registerkarten und Symbolleisten, die zum Erstellen und Verwalten von Sammlungen verwendet werden.

Bevor Sie mit Postman beginnen, sollten Sie ein Konto erstellen, um Ihre Sammlungen zwischen verschiedenen Geräten speichern und synchronisieren zu können.

Nach erfolgreicher Authentifizierung können Sie mit der Erstellung der Sammlung beginnen und andere von Postman bereitgestellte Funktionen verwenden.

Schritt 2: Erstellen einer neuen Sammlung

Nachdem Sie Postman erfolgreich installiert und ausgeführt haben, müssen Sie eine neue Sammlung erstellen. Führen Sie die folgenden Schritte aus:

Glückwunsch! Sie haben gerade eine neue Sammlung in Postman erstellt. Jetzt können Sie beginnen, Abfragen zu Ihrer Sammlung hinzuzufügen und sie zu organisieren.

Schritt 3: Hinzufügen von Abfragen zur Sammlung

Gehen Sie folgendermaßen vor, um einer Auflistung eine Abfrage hinzuzufügen:

1. Öffnen Sie die Sammlung, der Sie Abfragen hinzufügen möchten.
2. Klicken Sie auf die Schaltfläche "Abfrage hinzufügen" oder verwenden Sie Strg+Alt+ N.
3. Geben Sie einen Namen für die Abfrage ein, damit Sie sie in Zukunft leichter identifizieren können.
4. Wählen Sie die HTTP-Methode aus, die Sie verwenden möchten, um die Anforderung auszuführen (z. B. GET, POST, PUT, DELETE usw.).
5. Geben Sie die URL Ihres Endpunkts ein, den Sie aufrufen möchten.
6. Fügen Sie die erforderlichen Parameter oder Header hinzu, falls dies von Ihrer API oder Ihrem Webservice erforderlich ist.
7. Geben Sie bei Bedarf den Anforderungstext ein, z. B. die Daten, die Sie senden möchten.
8. Klicken Sie auf die Schaltfläche Speichern, um die Abfrage zur Sammlung hinzuzufügen.

Sie können Ihrer Sammlung so viele Abfragen hinzufügen, wie Sie benötigen. Dadurch können Sie verschiedene Funktionen Ihrer API oder Ihres Webdienstes testen und die Aktionen in Zukunft problemlos wiederholen.

Anmerkung: Wenn Sie eine Abfrage hinzufügen möchten, die die Autorisierung verwendet oder spezielle Einstellungen erfordert, können Sie sie auf der Registerkarte "Autorisierung" bzw.

Schritt 4: Konfigurieren der Abfrageparameter

Es gibt mehrere Einstellungsregisterkarten im oberen Abfragemenü wie "Params", "Authorization", "Headers" und andere. In jedem von ihnen können Sie bestimmte Parameter für Ihre Abfrage festlegen.

Params:

Auf der Registerkarte "Params" können Sie der URL Ihrer Anfrage Parameter hinzufügen. Sie können Parameter als Schlüsselwert hinzufügen, wobei Schlüssel der Name des Parameters und Wert der Wert des Parameters ist. Wenn Sie beispielsweise einen Parameter "id" mit dem Wert "1" haben, sieht die URL folgendermaßen aus: "https://api.example.com/users?id=1 ".

Params:id: 1

Authorization:

Auf der Registerkarte "Authorization" können Sie Ihrer Anfrage eine Autorisierung hinzufügen. Sie können verschiedene Autorisierungstypen auswählen, z. B. eine grundlegende Autorisierung oder ein Zugriffstoken. Nachdem Sie den Autorisierungstyp ausgewählt haben, müssen Sie die entsprechenden Autorisierungsdaten angeben (z. B. Login und Passwort für die grundlegende Autorisierung).

Authorization:Type: Basic AuthUsername: adminPassword: password

Headers:

Auf der Registerkarte "Headers" können Sie Ihrer Abfrage Titel hinzufügen. Header werden verwendet, um zusätzliche Informationen wie den Inhaltstyp, die Sprache, den Cache und andere zu übertragen. Sie können Titel als Schlüsselwert hinzufügen, wobei Schlüssel der Titel des Titels ist und Wert der Wert des Titels ist.

Headers:Content-Type: application/jsonAccept-Language: en

Durch das Konfigurieren von Abfrageparametern können Sie Ihre Abfragen flexibel anpassen und die gesendeten Daten verwalten. Dies ist sehr nützlich, wenn Sie verschiedene Abfrageoptionen testen und sehen müssen, wie sie mit Ihrer API interagieren.

Schritt 5: Hinzufügen der Autorisierung zur Sammlung

So fügen Sie Ihrer Sammlung eine Autorisierung hinzu:

1. Wählen Sie die Abfrage aus, zu der Sie die Autorisierung hinzufügen möchten.
2. Klicken Sie im rechten Fensterbereich auf die Registerkarte «Authorization» (Autorisierung).
3. Wählen Sie im Dropdown-Menü einen Autorisierungstyp aus. Postman unterstützt verschiedene Autorisierungstypen, z. B. grundlegende Autorisierung, OAuth sowie die benutzerdefinierte Autorisierung mit einem Token.
4. Klicken Sie auf »Add authorization" (Autorisierung hinzufügen).
5. Konfigurieren Sie die Autorisierungseinstellungen entsprechend den Anforderungen Ihrer API.
6. Speichern Sie die Änderungen, und wiederholen Sie diese Schritte bei Bedarf für andere Abfragen in der Sammlung.

Nachdem Sie der Sammlung eine Autorisierung hinzugefügt haben, enthält jede Anforderung, auf die die Autorisierung angewendet wurde, die entsprechenden Header oder Parameter, die für eine erfolgreiche Authentifizierung und Autorisierung erforderlich sind.

Stellen Sie sicher, dass Ihre Sammlung mit der angewendeten Autorisierung ordnungsgemäß funktioniert, um sicherzustellen, dass alle Abfragen erfolgreich sind und die erwarteten Ergebnisse erhalten.

Schritt 6: Parametrisieren von Abfragen

Um eine Abfrage zu parametrisieren, müssen Sie geschweifte Klammern <> in der URL verwenden, wo normalerweise der Parameterwert angegeben wird. Wenn Sie beispielsweise einen Parameter "id" haben, können Sie ihn wie folgt in der URL angeben: https://api.example.com/user / .

Nachdem Sie der URL einen Parameter hinzugefügt haben, können Sie auf die Registerkarte "Params" rechts neben der URL gehen und den Parameter zur Liste der Abfrageparameter hinzufügen. Hier können Sie einen Standardwert für einen Parameter angeben und ihn der Sammlung hinzufügen. Postman ersetzt bei jeder Anforderung automatisch den Parameterwert in der URL.

Eine weitere Möglichkeit zum Parametrisieren von Abfragen besteht darin, eine Variable zu verwenden. Eine Variable in Postman ist ein Wert, den Sie in verschiedenen Abfragen oder Umgebungen verwenden können. Sie können eine Variable in einem Postman definieren und sie in einer URL, einem Anforderungstext oder einem Header verwenden. Um eine Variable in einer URL zu verwenden, können Sie sie in geschweifte Klammern schreiben <>. Wenn Sie beispielsweise eine Variable "userId" haben, können Sie sie wie folgt in der URL angeben: https://api.example.com/user/>.

Durch die Parametrisierung von Abfragen können Sie Ihre API flexibler testen und ihr Verhalten auf verschiedenen Daten testen. Mit Postman können Sie ganz einfach viele Abfragevarianten mit unterschiedlichen Parameterwerten erstellen und diese bequem innerhalb Ihrer Sammlung verwalten.

Schritt 7: Testen der Sammlung

Nachdem Sie die Sammlung in Postman erstellt haben, ist es an der Zeit, sie zu testen. Durch das Testen der Auflistung wird sichergestellt, dass alle Abfragen ordnungsgemäß funktionieren und die erwarteten Ergebnisse zurückgegeben werden.

Es gibt mehrere Möglichkeiten, eine Sammlung in Postman zu testen. Eine davon ist die Verwendung von integrierten Funktionen zum Schreiben von JavaScript-Tests. Öffnen Sie dazu eine beliebige Abfrage in der Sammlung, wählen Sie die Registerkarte Tests aus und geben Sie Ihre Tests mithilfe der JavaScript-Syntax ein.

In JavaScript-Tests können Sie globale Variablen verwenden, z. B. Werte, die in einer Abfrage empfangen und in einer anderen Abfrage verwendet wurden, oder den Status der Antwort auf die Übereinstimmung mit dem erwarteten Wert überprüfen.

Eine andere Möglichkeit zum Testen ist die Verwendung von Postman Test Runner. Mit Test Runner können Sie alle Abfragen in einer Sammlung auf einmal ausführen und die Ergebnisse als Bericht anzeigen. Klicken Sie dazu auf die Schaltfläche "Ausführen" in der oberen Symbolleiste und wählen Sie die Sammlung aus, die Sie testen möchten.

Mit Test Runner können Sie auch Umgebungsvariablen konfigurieren, die in Tests verwendet werden können. Sie können Werte für Umgebungsvariablen festlegen, bevor die Tests ausgeführt werden, oder sie dynamisch verwenden, die in Tests basierend auf den Ergebnissen früherer Abfragen definiert wurden.

Nachdem Sie die Tests durchgeführt haben, sehen Sie die Ergebnisse als Bericht. Der Bericht zeigt den Status jeder Abfrage, die Ausführungszeit und die Testergebnisse an.

Verwenden Sie Sammlungstests in Postman, um sicherzustellen, dass Ihre API ordnungsgemäß funktioniert und die Erwartungen erfüllt.

Schritt 8: Exportieren und Importieren der Sammlung

Nachdem Sie Ihre Sammlung in Postman erstellt und konfiguriert haben, können Sie sie in einer Datei speichern, um sie mit anderen Benutzern zu teilen oder auf einem anderen Computer zu importieren.

Um eine Sammlung zu exportieren, wählen Sie die Sammlung im linken Postman-Bereich aus, klicken Sie mit der rechten Maustaste und wählen Sie Exportieren. Wählen Sie das Dateiformat aus, in dem Sie die Sammlung speichern möchten (z. B. JSON oder CSV), und geben Sie den Pfad zur Datei auf Ihrem Computer an.

Gehen Sie folgendermaßen vor, um eine Sammlung zu importieren:

1. Klicken Sie in Postman auf die Schaltfläche "Importieren".
2. Wählen Sie eine Datei mit Ihrer gespeicherten Sammlung aus.
3. Wählen Sie die Option Sammlung aus und geben Sie einen Pfad zum Importieren der Sammlung an.
4. Klicken Sie auf die Schaltfläche "Importieren".

Anmerkung: Alternativ können Sie eine Sammlung importieren, indem Sie ihre URL eingeben, wenn sie online verfügbar ist.

Ihre Sammlung ist jetzt bereit für die Verwendung auf anderen Computern oder für den Austausch mit anderen Postman-Benutzern!

Schritt 9: Veröffentlichen der Sammlung

Nachdem Sie die Sammlung erstellt und die erforderlichen Abfragen und Tests hinzugefügt haben, können Sie sie zur Freigabe veröffentlichen. Dies ist nützlich, wenn Sie Ihre Sammlung mit anderen Teammitgliedern oder externen Entwicklern teilen möchten.

Um eine Sammlung zu veröffentlichen, müssen Sie die folgenden Schritte ausführen:

1. Öffnen Sie die Sammlung, die Sie veröffentlichen möchten.
2. Klicken Sie oben rechts auf dem Bildschirm auf die Schaltfläche "Veröffentlichen".
3. Dann erscheint ein modales Fenster, in dem Sie "Public Access" auswählen müssen.
4. Sie können auch zusätzliche Veröffentlichungsoptionen konfigurieren, z. B. eine Beschreibung der Sammlung.
5. Nachdem Sie die Einstellungen konfiguriert haben, klicken Sie auf die Schaltfläche "Veröffentlichen".
6. Danach wird Ihre Sammlung veröffentlicht und über einen eindeutigen Link verfügbar gemacht.

Jetzt können Sie den Link zu Ihrer Sammlung mit anderen Benutzern teilen. Sie können Ihre Sammlung in ihren Postman importieren und zum Testen und Entwickeln verwenden.

Vergessen Sie nicht, dass die Sammlung beim Veröffentlichen für alle Benutzer mit Zugriff auf Ihren Link verfügbar ist. Seien Sie vorsichtig, wenn Sie keine vertraulichen Informationen oder Daten veröffentlichen, die nicht öffentlich zugänglich sein sollten.

Anmerkung: Wenn Sie eine veröffentlichte Sammlung löschen müssen, können Sie dies tun, indem Sie in der Postman-Mail auf die Registerkarte Veröffentlichte Sammlungen klicken und die Veröffentlichung für die entsprechende Sammlung abbrechen auswählen.