|
|
Die zwei Primärarchitektur für APIs ist REST und SEIFE. Wenn Sie Ihre API verursachen, haben Sie wirklich drei Wahlen: REST, SEIFE oder beide. REST APIs bekannt für Sein einfach und schnell, sich für zu entwickeln, aber der gesamte Antrag wird in den freien Raum unabhängig davon die Art der Verschlüsselung benutzt gesendet. SEIFE APIs sind komplizierter und erfordern mehr Bemühung, die Antwort zu erzeugen und den Antrag anzufassen, aber, lassen grössere Flexibilität zu, indem sie namespace Unterstützung addiert. Das Zur Verfügung stellen von von APIs beider Arten kann wie eine attraktive Wahl klingen, aber im Verstand halten, daß es Ihre Wartung, Unterstützung und Unterlagen Zeit für das Leben der API verdoppelt.
Beide API Methoden sind bereits ausführlich eingeführt worden; dieser Abschnitt konzentriert sich auf Unterschiede, um im Verstand zu halten, wenn er eine API entwickelt.
Wenn sie einen REST-Antrag, die Informationen hereinkommt über empfangen, ERHALTEN Sie. Als solcher, müssen alle Informationen während des Getriebes URL-KODIERT werden; Sie wünschen wahrscheinlich es decodieren, bevor Sie es der irgendwie Weiterverarbeitung unterwerfen (die Ausnahme, die usernames und Kennwörter ist, die im Allgemeinen verarbeitetes unbesehenes sind). Unterschiedliche Antragarten sollten an unterschiedliche Endpunkte (URLs) adressiert werden; wenn Sie einen einzelnen Index benutzen möchten, um alle Anträge anzufassen, können Sie jedes Geschenk es zu den Entwicklern dadurch daß Weise (alle Anträge gehen zu einem einzelnen Endpunkt), oder bauen Sie Ihr web server zusammen, um viele Endpunkte zu einem einzelnen Index abzubilden. Ich würde im Allgemeinen das letzte vorschlagen; er ist mit der Spezifikation Inline und er erlaubt Ihnen, Änderungen später vorzunehmen, ohne den externen Schnittstellen Entwicklergebrauch zu beeinflussen.
Erwägen Sie, Entwickler eine Netzschnittstelle benutzen zu lassen, um Anträge gegen die API zu bilden. Dieses kann vom großen Gebrauch beim Versuchen sein, ein Problem zu bestimmen; EntwicklerSIND in der Lage, schnell festzustellen, wenn das Problem der Antrag oder ihr Code ist. Mehr Werkzeuge, die Sie zu den Entwicklern in Diagnose, zur Verfügung stellen können, ist es, sich für Ihren Aufstellungsort zu entwickeln das einfacher ausgedrückt.
Wenn der SEIFE Antrag hereinkommt, sollte es zuerst überprüft werden, um sicherzugehen, daß es an das Format sich anpaßt, das durch Ihr WSDL Dokument spezifiziert wird. Wenn Sie ein Werkzeug wie NuSOAP benutzen, wird dieses für Sie getan. Tatsächlich der meiste SEIFE APIs Gebrauch irgendein Rahmen, der um einer Menge Grunzenarbeit kümmert, wenn es die Anträge anfaßt. SEIFE APIs Gebrauch, den ein einzelner Endpunkt für alle (als allgemeine Regel, einige große APIs unterschiedliche unvereinbare Funktionen auf unterschiedliche Endpunkte) verlangt, und infolgedessen haben Sie wahrscheinlich irgendein einen großen Index an diesem Punkt oder Lose require() Anrufe, die abhängig von dem bestimmten Anruf durchgeführt werden.
Erwägen Sie, Entwickler eine Netzschnittstelle benutzen zu lassen, in der sie gesamte Antragdokumente auf eine Form kleben können, und lassen Sie sie gegen Ihren Bediener laufen. Das Sprechen von der direkten Erfahrung, etwas wie dieses vorhandene habend ist vom großen Gebrauch zu den Entwicklern beim Versuchen, ein Problem zu bestimmen. Indexe oder Funktionen auf Ihrem Aufstellungsort zur Verfügung zu stellen, um Entwicklern zu erlauben, Anträge zu verursachen manuell ist auch von der Unterstützung zu den Entwicklern, die nicht einen SEIFE Rahmen verwenden.
Online: 550 users browsing the articles directory
|
|