Jforex Api Documentation Template

Das größte Problem hatte ich beim Lernen, meine eigenen Trading-Strategien in JForex programmieren zu finden, wo ich anfangen zu lernen. Es gab nur wenige JForex Dokumentation zur Verfügung, und ich musste mich durch mühevolle Versuch und Irrtum mit Hilfe von Dukascopys technische Unterstützung lehren. Die Dinge haben sich sicherlich zum Besseren verändert, da eine JForex-Community beginnt zu sprießen und die Dokumentation für sie ist mindestens ausreichend, um jedermann zu starten. Dieser Beitrag ist der erste einer Reihe von schnellen Anfänger Leitfaden zum Lernen JForex Programmierung, indem Sie alle diese Ressourcen in einem Tutorial. JForex ist ein Java-Tool JForex ist eigentlich keine Programmiersprache. Es ist eine Anwendungsprogrammierschnittstelle (API) für die Verwendung mit der Standard-Java-Programmiersprache. Als solcher ist der erste Schritt zum Lernen, in JForex zu programmieren, Java zu lernen. Zum Glück ist Java eine der beliebtesten Programmiersprachen. So gibt es viele Ressourcen auf und aus dem Internet zu lernen Java-Programmierung. Einige Beispiele für kostenlose Online-Tutorials sind: Die Java-Tutorials - Dies ist ein offizielles Tutorial vom Entwickler von Java selbst. Sehr empfehlenswert. Anfänger Java Tutorial - Mehr für die absolute Anfänger für die Programmierung ausgerichtet. Wenn Sie ein Buch bevorzugen, würde ich empfehlen Head First Java, 2. Auflage. Ich bürstete auf meinem Java aus diesem Buch. Dont auf Java zu viel, aber Sie müssen nur wissen, die Grundlagen zu beginnen mit JForex. Lesen Sie ein paar Kapitel, um die Java-Syntax zu verstehen und dann weiterzugehen. Sie können immer zurück zu ihnen später beziehen. Tauchen in JForex Das JForex Wiki ist eine der drei wesentlichen Ressourcen für JForex-Programmierer. Ich werde auf einige spezifische Seiten des Wiki in vielen dieser Reihe von Beiträgen beziehen. Wenn Sie das noch nicht getan haben, registrieren Sie sich für ein DEMO-Konto bei Dukascopy. Dann starten Sie die JForex-Plattform und folgen Sie den Anweisungen auf der JForex-Wiki-Seite verwenden, um Ihre erste JForex-Strategie zusammenzubauen Zusammenfassung So weit so gut In diesem Punkt hoffe ich, dass Sie grundlegenden Java-Quellcode verstehen und wissen, wie Sie starten / öffnen, Und führen Sie eine JForex-Strategie. Im nächsten Beitrag in diesem Lern-JForex-Serie, werden wir die Anatomie einer JForex-Strategie zu studieren. Why schreiben API Referenzdokumentation. Wenn Ihr Unternehmen APIs entwickelt, können Sie eine Referenzdokumentation für jede mit dem Produkt verfügbare API angeben. Die API-Dokumentation sollte die gemeinsamen Komponenten beschreiben, die von jedem der APIs für iOS, Android und andere Plattformen verwendet werden. Im Wesentlichen erläutert die API-Referenzdokumentation die verfügbaren Datenstrukturen über die APIs. Wenn gut geschrieben, erhöht dies die Nutzung und die Popularität Ihrer APIs und ermutigen Entwickler, Tester und Integratoren, Ihre API-Produkte zu verwenden. Was ist eine API? Was ist eine API Eine API (Application Programming Interface) ist eine Schnittstelle, die von einem Softwareprogramm implementiert wird, um die Interaktion mit anderer Software zu ermöglichen, ähnlich wie eine Benutzeroberfläche die Interaktion zwischen Mensch und Computer erleichtert. APIs werden durch Anwendungen, Bibliotheken und Betriebssysteme implementiert, um das Vokabular und die Aufrufkonventionen zu ermitteln, die der Programmierer verwenden sollte, um seine Dienste zu verwenden. Sie kann Spezifikationen für Routinen, Datenstrukturen, Objektklassen und Protokolle enthalten, die für die Kommunikation zwischen dem Verbraucher und dem Implementierer der API verwendet werden. Wikipedia-Konzept Eine API ist eine Abstraktion, die eine Schnittstelle für die Interaktion mit einer Reihe von Funktionen definiert und beschreibt, die von Komponenten eines Softwaresystems verwendet werden. Die Software, die die von einer API beschriebenen Funktionen bereitstellt, ist eine Implementierung der API. Generic der vollständige Satz von API, die in den Bibliotheken einer Programmiersprache gebündelt werden (zB die Standardvorlagenbibliothek in C oder die Java-API) Spezifisch, um ein bestimmtes Problem wie die Google MAPs-API oder die Java-API für XML-Webdienste anzugehen . Sprachabhängig nur in einer gegebenen Programmiersprache verfügbar. Es ist nur verfügbar, indem Sie die Syntax und die Elemente dieser Sprache verwenden, um die API in diesem Kontext bequem zu verwenden. Sprachunabhängig geschrieben, so dass es aus mehreren Programmiersprachen aufgerufen werden kann. Dies ist eine gewünschte Funktion für eine serviceorientierte API, die nicht an ein bestimmtes Prozess - oder System gebunden ist und als Remoteprozeduraufrufe oder Webdienste bereitgestellt werden kann. Beispielsweise kann eine Website, die es Benutzern ermöglicht, lokale Restaurants zu überprüfen, ihre Bewertungen über Karten, die von Google Maps übernommen werden, schichten, da Google Maps über eine API verfügt, die es zulässt. Die Google Maps8217-API steuert, welche Informationen eine Website von Drittanbietern erfassen kann und was mit ihr möglich ist. 8220API8221 kann verwendet werden, um auf eine komplette Schnittstelle, eine einzelne Funktion oder sogar einen Satz von mehreren APIs zu verweisen, die von einer Organisation bereitgestellt werden. Daher wird der Bedeutungsumfang gewöhnlich von der Person oder dem Dokument bestimmt, die die Information übermittelt. API Documentation Vorteile Ermutigen Plattform-Adoption als Entwickler in der Lage, den Code schneller zu reduzieren Reduziert Kundensupport Kosten als Entwickler können die Antworten, die sie finden können Erlauben Sie Programmierern, auf Codierung zu konzentrieren Sicherstellen, dass Software in der Tiefe API Documentation Struktur Übersicht dokumentiert die Vorteile der Verwendung der APIs und umfassen, wenn möglich, Diagramme Erste Schritte zu erklären, wie Sie loslegen, und andere Tutorials, die Orientierung des Lesers, zum Beispiel die Einstellung von Authentifizierung und Zugriff Token Referenzmaterial definieren den Zweck der einzelnen Ressourcen. Einstellung und Parameter im Code. Geben Sie Standardwerte und andere Informationen ein, die dem Leser helfen. Beispielcode Dies ist was ist von Interesse für den Entwickler. Fügen Sie Code-Beispiele, die viele detaillierte Kommentare haben, damit sie verstehen, wie jeder Parameter funktioniert. Geben Sie Standardwerte und Beispiele an Erste Schritte Stellen Sie viele Codebeispiele bereit, von hello world-Anwendungen bis hin zu komplexeren Beispielen. Die Schlüsselsache ist, ihnen zu helfen, begonnen zu erhalten. Tutorials tun dies auch. Gehen Sie sie durch einfache Anwendungsfälle, dann fügen Sie mehr Schichten von Komplexität, so dass sie arbeiten ihren Weg in die API. Beispielcode-Richtlinien Geben Sie Beispielcode an, den der Entwickler für den Einstieg verwenden kann. Entwickler lernen, indem sie Codierung nicht lesen. So geben ihnen Oodles Beispielcode, um mit zu beginnen. Code-Beispiele sollten die folgenden Abschnitte enthalten. Überblick über den Zweck dieses Codebeispiels. Ein Satz ist in der Regel genug. Anforderungen zum Ausführen des Codebeispiels Demonstriert, was passiert, wenn Sie den Code ausführen Beispielcode ausführliches Codebeispiel mit Kommentaren Erstellen Sie Beispielcode mit den folgenden Richtlinien: Kommentare Geben Sie Anmerkungen für jede Methode, Parameter oder Einstellung ein, die eine Erläuterung erfordert. Verwenden Sie Kommentare überall der Code ist nicht offensichtlich, vor allem, wenn Sie ein Work-around oder etwas ungewöhnliches dokumentieren müssen. Bei Bedarf können mehrere Zeilen lang sein. Verwenden Sie vollständige Sätze und haben Sie keine Angst, wortreich zu sein. Referenzmaterial Die meisten API-Dokumentationen sind Referenzmaterial. Hier werden die spezifischen Details für jede Ressource, Methode, Parameter sowie Standardwerte und Ausnahmen dokumentiert. Das Referenzmaterial beschreibt mindestens folgendes: Zweck des Elements, z. B. Anforderungsparameter Standardwerte Rückgabewerte Ausnahmen Empfehlungen Querverweise auf andere nützliche Informationen Codebeispiele Schreiben von API-Dokumentationen Freies eBook Klicken Sie hier, wenn Sie eine 16-seitiges Schreiben des API-Dokumententutorials, das erklärt, wie man jeden Abschnitt in Ihrer API-Referenzdokumentation schreibt. Es enthält hilfreiche erklärende Text, der Sie durch den Prozess der Dokumentation jeden Abschnitt in der API, einschließlich der Parameter, Endpunkte, Anfragen, Antworten und endpoints. Building eine Back-End-API-Schicht führt eine ganze neue Schicht der Koordination zwischen Server und Client Code. Zwar gibt es viele Aspekte für diese heikle Tanz der Kommunikation, ein wichtiger Bestandteil zur Minimierung von hinten und vor-Verwirrung über was-call-tut-was, konsistent kommuniziert über Ihre API-Endpunkte. Dies ist keineswegs Raketenwissenschaft, sondern im Laufe der Zeit I8217ve erstellt eine Vorlage, die ich jetzt neigen dazu, zu verwenden und wurden gebeten, zu teilen. Praktisch, wenn es an der Zeit ist, eine API extern zu veröffentlichen, ist dies ein unschätzbares Hilfsmittel für die Erstellung öffentlicher Unterlagen. Sie sehen die Markdown-Vorlage neben einem Beispiel in diesem Kern. Der Name Ihres API-Aufrufs Beispiel. Alle Benutzer anzeigen Hinweis: Versuchen Sie, Verben zu verwenden, die sowohl dem Anfragetyp (Abruf vs. Modifizieren) als auch der Mehrzahl entsprechen (ein vs. mehrere). Hinweis: Fügen Sie auch hier zusätzliche Informationen hinzu, wie z. B. eine Beschreibung. Die URL-Struktur (nur Pfad, keine Root-URL) / users oder / users /: id oder / usersid: id Für feste URLs: / Benutzer oder / Fotos Für URLs mit Parametern in ihnen: / users /: id or / photos /: Photoid oder / usersid: id Der Anfragetyp GET POST DELETE PUT Wenn URL-Params vorhanden sind, geben Sie diese in Übereinstimmung mit dem im URL-Abschnitt genannten Namen an. Separat in optional und erforderlich. Erforderlich: idinteger Beispiel: id12 Optional photoidalphanumeric Beispiel: photoid2345kj3 Wenn Sie eine Post-Anfrage, was sollte der Körper Payload aussehen Dies ist eine gute Zeit, um Ihre verschiedenen Datenbeschränkungen zu dokumentieren. Beispiel: Was ist der Statuscode auf Erfolg und gibt es zurückgegebene Daten Dies ist nützlich, wenn die Leute wissen müssen, was ihre Rückrufe erwarten sollten Beispiel: Code: 200 Inhalt: Die meisten Endpunkte haben viele Möglichkeiten, sie scheitern können. Von unberechtigtem Zugriff, zu falschen Parametern usw. All diese sollten hier aufgelistet werden. Es mag repetitiv erscheinen, aber es hilft verhindern, dass Annahmen gemacht werden, wo sie sollten. Beispiel: Code: 401 UNAUTHORIZED Inhalt: ODER Code: 422 Nicht verarbeitbar Einstiegsinhalt: Nur ein Beispielruf zu Ihrem Endpunkt in einem lauffähigen Format (.ajax-Aufruf oder Curl-Anfrage) 8211 macht das Leben einfacher und vorhersehbarer. Hier können alle Ungewissheiten, Kommentare, Diskussionen etc. gehen. Ich empfehle timestamping und identifiziere mich, wenn du Kommentare hier läßt. Gibt es andere Aspekte Ihrer API-Endpunkte, die Sie neigen zu kommunizieren, welche zusätzlichen Informationen werden geteilt von Irene Ros am 22. August 2012