API -Gebäude und -Tests erleichterten den Postboten

Postman: Ein leistungsstarkes Tool zur Vereinfachung der API -Entwicklung und zum Testen

Schlüsselpunkte:

• Postman ist ein leistungsstarkes Tool, das die API -Entwicklung und -Testprozesse vereinfacht, Funktionen wie das Speichern vergangener API -Anrufe und Gruppierung von API -Aufrufen, die bequem und schnell sind.
• APIs (Anwendungsprogrammierschnittstelle) werden normalerweise mit dem REST-Framework (Desotative Status Transfer) erstellt, das Richtlinien für webbasierte APIs festlegt. Die vier häufigsten Operationen, die durch die API ausgeführt werden, sind, Objekte zu erstellen, zu erstellen, zu bearbeiten und zu löschen.
• API -Tests sind ein entscheidender Bestandteil des Entwicklungsprozesses, um Funktionen, Ausnahmebehandlung und Sicherheit zu gewährleisten. Dies kann durch die Verwendung der Befehlszeile der Curl -Bibliothek erfolgen, aber Tools wie Postman können diesen Vorgang erleichtern.
• Postman kann verwendet werden, um Anfragen an APIs wie Facebook -Graph -API zu senden, mit der Entwickler Beiträge wie Beiträge, Erstellen von Beiträgen und Löschen von Posts anzeigen können. Dieses Tool kann ein wertvolles Gut für Entwickler sein, die APIs verwenden.

Dank Jeff Smith für seine Hilfe war er begeistert von der Teilnahme an der Peer Review in diesem Artikel.

---

beliebte Artikel auf der SitePoint -Website heute:

• Was ist HTTP/2?
• Verwenden Sie diese drei CSS -Methoden, um unkontrollierbare Stilblätter zu zähmen
• Ihre reguläre WordPress -Wartungsliste
• Shared Server Hosting: Pros and Cons
• Warum benötigt jede Website https

---

API (Anwendungsprogrammierschnittstelle) ist das Medium für die Interaktion zwischen Anwendungen. APIs, die HTTP oder HTTPS verwenden, werden als Web -APIs bezeichnet.

Wenn Sie sich im Internet umsehen, werden Sie feststellen, dass eine große Anzahl von Diensten APIs verwendet. Jeder Service mit Social Login verwendet die API.

Durch das Erstellen von APIs für Ihre Dienste können Sie Entwickler von Drittanbietern ermöglichen, Anwendungen basierend auf Ihren Diensten zu erstellen. Beispielsweise verwendet die Social News Site Frrole die Twitter -API, um kontextbezogene Erkenntnisse zu generieren, indem eine große Anzahl von Tweets analysiert wird.

Unter der Annahme, dass Sie die Vor- und Nachteile der Erstellung einer API bewertet haben, lassen Sie uns kurz den Prozess des Erstellens und Testen einer API erörtern.

api

erstellen

Obwohl es viele Möglichkeiten gibt, APIs zu erstellen, wird die Web -API mit dem REST -Framework (Denotative Status Transfer) erstellt. Das REST -Framework gibt eine Reihe von Richtlinien an, die beim Erstellen von APIs befolgt werden müssen. Aufgrund der zahlreichen APIs, die täglich erstellt wurden, wird es zum Standard für webbasierte APIs.

Die vier häufigsten Operationen, die durch die API ausgeführt werden, sind die Ansichten, Erstellen, Bearbeiten und Löschen von Objekten. Das REST -Framework bildet vier HTTP -Verben auf diese Operationen: Get, Post, Put und Löschen. In dieser Liste werden viele Verben hinzugefügt, wie z. B. Säuber und Patch, aber in diesem Artikel werden wir nur vier grundlegende Verben diskutieren. Ein Artikel über pragmatische Rastful-API-Best Practices des Gründers von Enchant.com Vinay Sahni kann für Erstentwickler nützlich sein.

Viele Frameworks heute bieten Wrapper für die grundlegende HTTP -Ebene und erleichtern Ihre Entwicklung. Sie müssen nur den erforderlichen Befehl oder die erforderliche Funktion aufrufen und sich auf die Funktion konzentrieren. Beliebte Beispiele sind Slim und Toro, zwei PHP-basierte Miniatur-Frameworks, mit denen Sie schnell REST-APIs erstellen können.

Test API durch Cli

Der Hauptzweck bei der Erstellung von APIs besteht darin, andere Anwendungen (wahrscheinlich Ihre eigenen oder von Dritten entwickelten) diese Dienste zu ermöglichen. Daher besteht ein entscheidender Schritt in jeder Phase des API -Entwicklungsprozesses darin, die Funktionalität, Ausnahmebehandlung und Sicherheit der API zu testen.

Verwenden einer API beinhaltet eine Anfrage an eine gewünschte Ressource (normalerweise eine URL) unter Verwendung eines der Verben (oder Methoden). Abhängig von den Anforderungen der von Ihnen verwendeten API müssen Sie möglicherweise einen Header hinzufügen. Eine Möglichkeit, solche Ressourcen anzufordern, ist die Befehlszeile.

In diesem Artikel werden wir uns auf vier Teile von API -Aufrufen konzentrieren - URL, HTTP -Verb, Header und Parameter. Wir werden die Curl -Bibliothek verwenden, um Anfragen über die CLI an API -Ressourcen zu senden. CURL ist ein Befehlszeilen -Tool, mit dem Daten mithilfe der URL -Syntax übertragen werden können - unterstützt FTP, FTPS, HTTP, HTTPS.

schauen wir uns den folgenden Befehl an:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

Der Befehl

-i steht für include, der dem Befehl mitteilt, dass der Header in der Anfrage vorhanden ist. -X folgt sofort dem HTTP -Verb oder der Methode. -H gibt den benutzerdefinierten Header an, der der Anfrage hinzugefügt wurde. Schließlich gibt die Option -d die benutzerdefinierten Formulardaten an, die mit der Anforderung übergeben werden sollen.

Das Ergebnis des

-API -Aufrufs ist eine HTTP -Antwort, die normalerweise im JSON -Format codiert wird. Die Antwort wird mit einem HTTP -Antwortcode versehen, der Informationen zum Anforderungsstatus enthält (z. B. 200 bedeutet OK, 404 bedeutet, dass die Ressource nicht vorhanden ist, 500 den Serverfehler und 403 bedeutet, dass die Ressource verboten ist). Beispielsweise kann die folgende Antwort als Ergebnis einer früheren Anfrage sowie eines 200 -Status -Codes gesendet werden:

<code>{"message":"success","id":"4"}</code>

Testen solcher Antworten innerhalb der Befehlszeile stellt ebenfalls eine Herausforderung dar, insbesondere wenn die Antwort eine große Anzahl von Optionen hat.

Diese detaillierte Anleitung aus Codingpedia listet die CLI -Optionsliste beim Testen der API auf.

Vereinfachen Sie das Test mit Postman

Postman ist ein leistungsstarkes API -Entwicklungskit, das den API -Entwicklungsprozess schnell und einfach macht. Es kann als Chrome -Erweiterung und native Anwendungen für Mac, Windows und Linux verwendet werden. Mehr als eine Million Entwickler haben es versucht. Um Chromerweiterungen zu installieren, müssen Sie zuerst Chrome installieren und dann zur Projektseite des Chrome -Webstores wechseln.

Lassen Sie uns zunächst verstehen, wie wir unsere vorherigen CLI -Anfragen über Postbote simulieren. Das folgende Bild zeigt, dass das Erstellen eines API -Aufrufs in Postman mit allen vier oben diskutierten Teilen erstellt wird:

Zusätzlich zur Vorschau (wenn die Antwort HTML ist) können die Antworten, die Sie über die Anfrage erhalten, auch in origineller oder schöner Form angesehen werden. Das folgende Bild zeigt unterschiedliche Möglichkeiten, Antworten in Postman anzuzeigen:

Postman speichert automatisch API -Anrufe, die Sie in der Vergangenheit getätigt haben, um Zeit beim Testen der API zu sparen. Darüber hinaus können sie in zugehörige API -Forderungen für Ihre Bequemlichkeit eingeteilt werden. Hier ist ein Beispiel für die API -Anrufverlauf durch Postbote:

Verwenden von Facebook -Graph -API über Postman

Ein guter Weg, um zu demonstrieren, wie Postman funktioniert, ist die Facebook -Graph -API. In diesem Beitrag konzentrieren wir uns auf Beiträge zur Zeitleiste des Benutzers, wie die Details der Beiträge angezeigt werden und wie Sie Beiträge erstellen und löschen.

Zugriffstoken sind bei der Verwendung der Graph -API von entscheidender Bedeutung. Ein Token ist mit vielen Berechtigungen verbunden. Sie können beispielsweise einen Beitrag mit einem Token nur dann erstellen, wenn Publish_actions eines der ausgewählten Felder beim Generieren eines Tokens ist. Diese zusätzliche Sicherheitsstufe kann Ihnen dabei helfen, einer bestimmten Anwendung spezifische Aktionen zu erteilen, wenn Sie über Facebook angemeldet werden.

Beiträge

anzeigen

Um eine Anfrage an die Graph -API zu senden, müssen Sie ein Zugriffstoken generieren. Nachdem Sie das Token generiert haben, sollten Sie eine GET -Anforderung an die folgende URL senden und als Parameter Access_Token verwenden:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

Das folgende Bild zeigt den grundlegenden Graph -API -Anruf mit Ihren Details:

Sie können die Liste der Beiträge in Ihrer Zeitleiste überprüfen, indem Sie dem Befehl folgen:

<code>{"message":"success","id":"4"}</code>

hier ist, wie die Details der Postliste in Ihrer Zeitleiste angezeigt werden:

Um die Details eines einzelnen Beitrags anzuzeigen, verwenden Sie die folgenden Ressourcen:

<code>GET /me/</code>

Die Details eines einzelnen Beitrags sind wie folgt:

wie

Senden Sie einfach eine Postanforderung an die folgende URL (bitte beachten Sie, dass Likes Publish_actions erfordern):

<code>GET /me/feed/</code>

Senden Sie eine ähnliche Anfrage über Postman wie folgt:

In ähnlicher Weise können Sie das Like löschen, indem Sie eine Löschenanforderung an dieselbe URL senden:

<code>GET /post-id/</code>

Erstellen Sie einen Beitrag

Um einen Beitrag zu erstellen, müssen Sie zusätzlich zur Postanforderung einige Parameter senden. Sie brauchen auch zu veröffentlichen.

Sie können Ihrer Postanforderung die folgenden Optionen hinzufügen:

• Nachricht: Nachricht zugeordnet mit dem Beitrag
zugeordnet
• Link: Link zu externen Ressourcen
• Platz: Der mit dem Beitrag zugeordnete Ort (ähnlich wie "Check-in" A-Speicherort)
• Tags: Jeder Freund oder Seite
• Privatsphäre: Das Publikum für Beiträge, die sichtbar sind
• Object_attachment: Alle vorhandenen Facebook -Beitrag

In der Dokumentation wird erläutert, wie all diese Funktionen verwendet werden.

Sie können Beiträge in Ihrer eigenen Zeitleiste oder in der Zeitleiste von Benutzern, Seiten, Ereignissen oder Gruppen erstellen, die auf der URL basieren, die Sie für die Anforderung senden:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

Versuchen wir, in unsere eigene Zeitleiste zu posten. Wenn die Anfrage erfolgreich ist, erhalten wir die ID des erstellten Beitrags. Hier ist ein Beispiel für das Erstellen eines neuen Beitrags mit der Graph -API:

Um einen Beitrag zu bearbeiten

<code>{"message":"success","id":"4"}</code>

Beiträge

löschen

Genau wie beim Löschen eines Posts müssen Sie eine Löschenanforderung an die Post -URL senden:

<code>GET /me/</code>

Hinweis: Wir haben in diesem Artikel gesehen, dass Postman viele nützliche Funktionen hat. Nach dem Upgrade der kostenlosen Version (9,99 USD pro Lizenz) gibt es mehr Funktionen - zum Beispiel das Ausführen von API -Sammlungen auf mehreren Datenwerten.

Schlussfolgerung

Eine API erstellen ist eine entscheidende Aufgabe, die viele wichtige Schritte umfasst. Postbote erleichtert den gründlichen Testprozess. Derzeit scheint der Postman das Problem des durchschnittlichen Entwicklers gut zu lösen. Wie es sich mit den Paradigmenverschiebungen in der Webindustrie entwickelt, bleibt jedoch zu sehen.

Fehlen wir die wichtigen Merkmale des Postboten? Verwenden Sie einen anderen Client, um die API zu testen? Bitte teilen Sie es uns in den Kommentaren unten mit.

häufig gestellte Fragen zum Erstellen und Testen von APIs mit Postman

Was ist Postbote und wie hilft es, APIs zu erstellen und zu testen?

Postman ist ein beliebtes Tool für Entwickler, um APIs zu erstellen und zu testen. Es bietet eine benutzerfreundliche Oberfläche, mit der das Senden von HTTP-Anforderungen und das Anzeigen von Antworten einfach sendet. Postman unterstützt verschiedene Arten von HTTP -Anfragen, z. B. Get, Post, Löschen, Put usw. Sie können auch Anfragen speichern und in eine Sammlung für einfachen Zugriff und Freigabe organisieren. Mit den integrierten Testfunktionen von Postman können Sie Tests für Ihre API direkt im Tool selbst schreiben, was es zu einer umfassenden Lösung für die API-Entwicklung macht.

Ist Postman frei zu verwenden?

Postman bietet kostenlose und bezahlte Versionen. Die kostenlose Version "Postman Basic" bietet eine leistungsstarke Reihe von Funktionen, die ausreichen, um den Anforderungen einzelner Entwickler oder kleiner Teams zu erfüllen. Postman bietet einen kostenpflichtigen Plan für große Teams oder Unternehmen an, die fortschrittliche Funktionen und Zusammenarbeit erfordern.

Wie unterscheidet sich Postman Pro von der Grundversion?

Postman Pro ist eine kostenpflichtige Version, die zusätzliche Funktionen bietet, die in der Basisversion nicht zu finden sind. Dazu gehören die Zusammenarbeit des Teams, die API -Überwachung, die erweiterte API -Dokumentation und vieles mehr. Es ist für professionelle Entwickler und Teams konzipiert, die komplexe API -Entwicklungsprojekte verwalten müssen.

Wie kann ich Postbote kaufen?

Sie können Postbote von ihrer offiziellen Website kaufen. Sie bieten unterschiedliche Preispläne an, die auf Ihrer Teamgröße und Ihren spezifischen Anforderungen basieren. Sie können einen Plan auswählen, der Ihren Anforderungen entspricht und den Eingabeaufforderungen entspricht, den Kauf abzuschließen.

Welche Rolle spielt der Postbote in der Softwareentwicklung?

In der Softwareentwicklung spielt der Postman eine entscheidende Rolle bei der Entwicklung und Prüfung der API. Es ermöglicht Entwicklern, APIs auf einer einzelnen Plattform zu erstellen, zu testen und zu dokumentieren, wodurch der Entwicklungsprozess vereinfacht wird. Es unterstützt auch die Zusammenarbeit und erleichtert den Teams, gemeinsam an API -Projekten zu arbeiten.

Kann ich Postman für automatisierte Tests verwenden?

Ja, Postman unterstützt automatisierte Tests. Sie können Tests für Ihre API in Postman schreiben und sie automatisch mit dem Collection Runner oder Newman (Postman's Command Line Tool) ausführen. Dies erleichtert die Integration von API -Tests in Ihre kontinuierliche Integration/Continuous Delivery (CI/CD) -Pipeline.

Wie organisiere ich meine API -Anfragen in Postman?

Mit

Postman können Sie API -Anfragen in Sammlungen organisieren. Eine Sammlung ist eine Reihe verwandter Anfragen, die zusammen gespeichert werden können. Dies erleichtert das Verwalten und Teilen Ihrer Anfragen. Sie können der Sammlung auch Ordner für weitere Organisationen hinzufügen.

Unterstützt Postman -Unterstützung verschiedene Arten der Authentifizierung?

Ja, Postman unterstützt verschiedene Authentifizierungstypen, einschließlich Basic -Auth, Bearer -Token, OAuth 1.0, OAuth 2.0 und mehr. Dies macht es zu einem vielseitigen Tool zum Testen von APIs mit unterschiedlichen Authentifizierungsanforderungen.

Kann ich meine Postman -Sammlung mit anderen teilen?

Ja, Postman ermöglicht es Ihnen, Ihre Sammlung mit anderen zu teilen. Dies ist besonders nützlich für die Teamarbeit. Wenn Sie eine kostenpflichtige Version verwenden, können Sie die Sammlung freigeben, indem Sie sie als JSON -Datei exportieren oder direkt vom Postboten teilen.

Wie kann man lernt, Postboten effektiv zu nutzen?

Es gibt viele Ressourcen, um Postbote zu lernen. Die offizielle Postman -Website bietet umfassende Dokumentation und Tutorials. Es gibt auch viele Online -Kurse, Blogs und Foren, in denen Sie die Erfahrungen anderer Postman -Benutzer lernen können.

Das obige ist der detaillierte Inhalt vonAPI -Gebäude und -Tests erleichterten den Postboten. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!