Jforex Api Dokumentation Beispiele

Designing Great API Docs Schreiben Dokumentation ist eines der Dinge, die von vielen Entwicklern gefürchtet wird. Es braucht viel Aufwand und Zeit, um nach rechts zu kommen. Und zu oft, Menschen nehmen Verknüpfungen. Das ist traurig, denn eine gut gestaltete Dokumentation ist der Schlüssel zum Erhalten der Leute, die über Ihr Projekt begeistert sind, egal ob es sich um Open Source oder um ein Entwickler-fokussiertes Produkt handelt. In der Tat behaupte ich, dass das wichtigste UX-Produkt für ein Entwicklerprodukt nicht die Homepage oder der Anmeldeprozess oder das SDK-Download ist. Es ist die API-Dokumentation Wer kümmert, wenn Ihr Produkt die mächtigste Sache in der Welt ist, wenn niemand versteht, wie es zu benutzen. Wenn Sie ein Entwickler-fokussiert Produkt machen, ist die Dokumentation als Kern für die Benutzerfreundlichkeit als Endpunkte selbst. Ive gesehen viel zu viele Projekte, die einfach Dump Sie auf eine GitHub-Seite mit einem Zwei-Liner-Readme. Die erfolgreichsten API-Dokumente werden sorgfältig mit Liebe angefertigt. Hier bei Parse widmen wir uns dieser Kunst. Also, welche Elemente gehen in die Herstellung großer API-Dokumentation Dokumentation ist ein Layered Beast Ihre Dokumentation sollte nicht nur eine einfache Auflistung der Endpunkte mit ihren Parametern. Die Dokumentation ist ein ganzes Ökosystem von Inhalten, das die Benutzer auf die Interaktion mit Ihrer API aufmerksam macht. Zumindest sollten Sie diese Komponenten: Referenz: Dies ist die Auflistung aller Funktionalität in qualvollen Details. Dazu gehören alle Datentypen und Funktionsspezifikationen. Ihre fortgeschrittenen Entwickler verlassen diese offen in einem Tab den ganzen Tag. Guides: Dies ist irgendwo zwischen der Referenz und Tutorials. Es sollte wie Ihre Referenz mit Prosa, die erklärt, wie Sie Ihre API verwenden. Tutorials: Diese lehren Ihre Benutzer spezifische Dinge, die sie mit Ihrer API tun können, und sind in der Regel eng auf nur ein paar Stücke der Funktionalität konzentriert. Bonuspunkte, wenn Sie einen Beispielcode enthalten. Bei Parse haben wir alle drei dieser Komponenten und arbeiten zurzeit an weiteren Tutorials. Entfernen Sie Abstraktionen mit Beispielen Sie konnten argumentieren, dass Ihre API eine große Abstraktion ist, und das ist Art des Punktes. Allerdings, wenn Lehre Entwickler, versuchen, so viele Abstraktionen wie möglich zu entfernen. Überprüfen Sie in Ihrer Dokumentation echte Beispiele aus der ganzen Welt. Kein Entwickler wird jemals beklagen, dass es zu viele Beispiele. Sie reduzieren drastisch die Zeit für Entwickler, Ihr Produkt zu verstehen. Tatsächlich haben wir sogar Beispielcode direkt auf unserer Homepage. Es ist kein Geheimnis, dass Entwickler hassen zu klicken. Dont verbreiten Sie Ihre Dokumentation auf eine Million verschiedene Seiten. Halten Sie verwandte Themen nahe beieinander auf derselben Seite. Es waren große Fans von langen Seitenführungen, die es den Nutzern ermöglichen, das große Bild zu sehen, mit der Fähigkeit, mit einer persistenten Navigationsleiste einfach in die Details zu zoomen. Dies hat die große Nebeneffekt, dass Benutzer können alle Inhalte mit einem In-Page-Browser-Suche. Ein gutes Beispiel dafür ist die Dokumentation von Backbone. js. Die alles an Ihren Fingerspitzen hat. Fügen Sie einen sanften Quickstart Der härteste Teil der Annahme einer neuen API ist direkt am Anfang, wo die Lernkurve steil ist und der Entwickler ist kompliziert neue Ideen ausgesetzt. Die Lösung hierfür ist die Einführung der API mit einer Kurzanleitung. Das Ziel des Schnellstarts ist, den Benutzer durch die minimalen Schritte zu gehen, die benötigt werden, um das kleinste Ding zu tun, das in Ihrer API möglich ist. Nichts mehr. Sobald ein Benutzer dies getan hat, sind sie bereit, auf die erweiterten Konzepte zu bewegen. Zum Beispiel, unsere Quickstart-Guide hat der Benutzer unsere SDKs herunterladen und speichern Sie dann ein Objekt auf unserer Plattform. Wir haben sogar eine Schaltfläche, die Benutzer testen können, ob sie das richtig gemacht haben. Das gibt ihnen das Vertrauen, weiterzumachen und den Rest unserer Plattform zu erlernen. Verwenden Sie mehrere Sprachen Wir leben in einer polyglotten Welt. Gegebenenfalls versuchen Sie, Beispiele für mehrere Sprachen aufzulisten, die Ihre API unterstützt, höchstwahrscheinlich über Client-Bibliotheken. Das Erlernen einer neuen API ist hart genug, ohne die ungewohnten Sprachen analysieren zu müssen. MailGuns API macht einen großartigen Job, indem sie Entwickler zwischen curl, Ruby, Python, Java, C und PHP für die Beispiele in einem globalen Menü wählen können. Sie können nie über-kommunizieren Edge Fällen Das Schlimmste ist, mit einer API nur entwickeln, um einen Fehler-Zustand, der nicht dokumentiert zu entdecken. In Situationen wie diesem kann es unklar sein, ob der Fehler in Ihrem Code oder in Ihrem Verständnis der API ist. Ihre Referenz sollte jeden Randfall und jede Annahme enthalten, die entweder implizit oder explizit erfolgt. Wenn Sie ein paar Minuten damit verbringen, können Sie Stunden Ihrer Nutzer kollektive Zeit sparen. Am Ende des Tages wollen die Entwickler das große Bild sehen. Und die beste Weise, zu zeigen, daß mit Arbeitsbeispielanwendungen ist. Ich finde, dass Anwendungscode die beste Weise ist, zu kommunizieren, wie alles in Ihrer API zusammen bindet und wie es mit anderen Systemen integriert. Ein gutes Beispiel dafür ist Beispielcode in Apples iOS Developer Library. Die eine erschöpfende Auswahl von Beispiel-iOS-Apps nach Thema organisiert hat. Lesen API-Dokumentation ist nicht genau eine spannende Achterbahnfahrt. Aber, können Sie mindestens etwas Persönlichkeit und Spaß in Ihrem Schreiben hinzufügen. Überraschen Sie Ihre Leser mit lustigen Beispielen und Variablennamen außer foo. Das hindert sie wenigstens daran, einzuschlafen. Der Weg zu einem Entwicklerherz ist eine großartige Dokumentation. Und große Dokumentation erfordert viel Investition. Aber diese Investition lohnt sich und ist genauso wichtig für ein Entwicklerprodukt wie die API selbst. Die andere Hälfte ist die Gestaltung einer großen API in den ersten Platz. Aber, das wird das Thema einer anderen Stelle sein. Psst: Wenn Sie gut entworfene APIs lieben und Lehrende über sie lehren, stellten Sie einen Entwickler-Evangelist an Parse ein. Posted on January 11th, 2012JForex API JForex API bietet die Möglichkeit, benutzerdefinierte Software-Anwendungen mit Java-Programmiersprache zu entwickeln. Die API-Client-Bibliothek kann mit Kundensystemen verknüpft werden. Es kommuniziert direkt mit Dukascopy Bank Handel Server über sichere und authentifizierte Internet-Sitzungen. Es ist nicht notwendig, gleichzeitig die JForex-Plattform auszuführen, aber die Plattform kann in Echtzeit verwendet werden, um alle Aktionen eines Kundensystems zu überwachen. Um mit dem JForex Software Development Kit (JForex SDK) zu arbeiten, laden Sie es in eine IDE (Java Integrated Development Environment) Ihrer Wahl herunter und importieren Sie es: Das JForex SDK enthält Beispiele für: Tests im visuellen Modus Im JForex SDK-Überblick wird beschrieben, wie diese Anwendungsfälle modifiziert und verbessert werden können. Zur Strategieentwicklung starten Sie mit der Strategie-API-Übersicht. Die aktuellen JForex SDK Abhängigkeiten finden Sie immer im öffentlichen Dukascopy Maven Repository. Dass Sie ihr Projekt so konfigurieren können, dass immer die neueste JForex-API-Version verwendet wird. Bleiben Sie auf dem Laufenden mit unseren neuesten Entwicklungen von Jforex api und abonnieren Sie automatische E-Mails von Jforex API-Versionshinweisen. Vergessen Sie auch nicht, unser API-Support-Forum zu überprüfen, wo alle Jforex-API-Versionen veröffentlicht und diskutiert werden.