REST API vs SOAP-API-Technologie

Die beiden primären Architekturen für APIs sind REST und SOAP. Bei der Erstellung Ihrer API, die Sie wirklich haben drei Möglichkeiten: REST, SOAP, oder beides. REST-APIs sind für ihre einfache und schnelle Entwicklung für bekannt, aber die gesamte Meldung wird im Klartext gesendet, unabhängig von der Art der Verschlüsselung verwendet. SOAP-APIs sind komplexer und erfordert mehr Aufwand, um die Reaktion zu erzeugen und verarbeiten die Anfrage, aber ermöglichen eine größere Flexibilität, indem Namespace unterstützen. Bereitstellung von APIs der beiden Arten können wie eine attraktive Option klingen, aber bedenken Sie, dass es Ihre Wartung, Support und Dokumentation Zeit für das Leben der API zu verdoppeln.

Beide API-Methoden sind bereits ausführlich eingeführt worden, dieser Abschnitt konzentriert sich auf die Unterschiede zu berücksichtigen bei der Entwicklung einer API zu halten.

REST-APIs

Beim Empfang einer REST Wunsch werden die Informationen in über GET kommen. Als solche werden alle Daten müssen URL-während der Übertragung verschlüsselt, werden Sie wahrscheinlich wollen es lassen, bevor er eine weitere Verarbeitung (mit Ausnahme Benutzernamen und Passwörter, die in der Regel verarbeitet werden, wie sie ist) zu dekodieren. Verschiedene Arten Anfrage sollte sich auf unterschiedliche Endpunkte (URLs) angesprochen werden, wenn Sie ein einzelnes Skript verwenden, um alle Anfragen zu bearbeiten, können Sie entweder präsentieren die Entwickler auf diese Weise (alle Anfragen gehen auf einen einzigen Endpunkt), oder konfigurieren Sie Ihre Web-wünschen Server, um viele Endpunkte ein einziges Skript. Ich würde vorschlagen allgemein die letztere, es ist inline mit der Spezifikation und ermöglicht es Ihnen, Änderungen später machen, ohne die externen Schnittstellen-Entwickler nutzen.

Betrachten Sie ermöglicht es Entwicklern, ein Web-Interface nutzen, um Anfragen an die API zu machen. Dies kann von großem Nutzen, wenn Sie versuchen, ein Problem zu diagnostizieren, können Entwickler schnell feststellen, ob das Problem im Antrag oder ihren Code. Je mehr Werkzeuge Sie können die Entwickler in Sachen Diagnose liefern, desto leichter wird es sein, für Ihre Website zu entwickeln.

SOAP-APIs

Wenn die SOAP-Anfrage eingeht, sollte zunächst überprüft, um sicherzustellen, dass es um das Format von Ihrem WSDL-Dokument angegeben konform ist. Wenn Sie ein Tool wie nusoap, ist dies für Sie erledigt. In der Tat nutzen die meisten SOAP-APIs einige Rahmenbedingungen, kümmert viele der Routinearbeit bei der Handhabung der Anträge. SOAP-APIs verwenden einen einzigen Endpunkt für alle Anfragen (in der Regel, einige große APIs separate disparaten Funktionen auf verschiedene Endpunkte), und als Ergebnis werden Sie wahrscheinlich entweder eine große Schrift an diesem Punkt, oder viel require () ruft ausgeführt je nach den besonderen Ruf.

Betrachten Sie es Entwicklern ermöglicht, eine Web-Oberfläche, wo sie ganze Anfrage Dokumente in ein Formular einfügen können, und führen Sie sie vor Ihrem Server verwenden. Apropos aus direkter Erfahrung, mit so etwas wie dieses verfügbar ist von großem Nutzen für die Entwickler beim Versuch, ein Problem zu diagnostizieren. Die Bereitstellung von Skripts oder Funktionen auf Ihrer Website zu ermöglichen Entwicklern, Anfragen manuell erstellen wird ebenfalls hilfreich sein, um Entwickler nicht mit einem SOAP-Framework.