Jforex Esempi Documentazione Api

Progettare Grande Documentazione API documentazione La scrittura è una di quelle cose che è temuta da molti sviluppatori. Ci vuole un sacco di fatica e tempo per ottenere di destra. E troppo spesso, la gente prende scorciatoie. Questo è triste, perché la documentazione ben progettato è la chiave per ottenere la gente entusiasta del progetto, se la sua open source o uno sviluppatore di concentrati del prodotto. In realtà, io sostengo che il pezzo più importante di UX per un prodotto sviluppatore non è il homepage o il processo di iscrizione o l'SDK download. La sua la documentazione API Chi se ne frega se il prodotto è la cosa più potente del mondo, se non si capisce come usarlo. Se sei un fare un prodotto focalizzato sviluppatore, la documentazione è quanto di base per l'esperienza degli utenti, come i punti finali stessi. Ho visto troppi progetti che semplicemente eseguire il dump di una pagina GitHub con un readme due-liner. La documentazione API di maggior successo sono accuratamente realizzati con amore. Qui a Parse, ci dedichiamo a questa arte. Quindi, quali sono gli elementi vanno a fare grande documentazione API La documentazione è un Layered Bestia La documentazione shouldnt essere solo una lista piana di endpoint con i loro parametri. La documentazione è un intero ecosistema di contenuti che si propone di insegnare agli utenti come interagire con il API. Per lo meno, si dovrebbe avere questi componenti: Riferimento: Questa è la lista di tutte le funzionalità in dettaglio lancinante. Questo include tutte le specifiche tipo di dati e la funzione. I suoi sviluppatori avanzati lasceranno questo apre in una scheda per tutto il giorno. Guide: Questo è da qualche parte tra il riferimento e tutorial. Dovrebbe essere come il vostro riferimento con la prosa che spiega come utilizzare il API. Tutorial: Questi insegnate ai vostri utenti le cose specifiche che possono fare con il vostro API, e di solito sono strettamente concentrati su pochi pezzi di funzionalità. I punti di fx se si includono il codice di esempio di lavoro. A Parse, abbiamo tutte e tre queste componenti, e sono stati attualmente lavorando a ideare altre esercitazioni. Rimuovere Astrazioni con esempi si potrebbe sostenere che la vostra API è una grande astrazione, e questo è questo il punto. Tuttavia, quando si insegna agli sviluppatori, cercare di rimuovere il maggior numero di astrazioni possibile. Liberamente cospargere esempi reali di tutta la documentazione. Nessuno sviluppatore potrà mai si lamentano che ci sono troppi esempi. Essi riducono drasticamente il tempo per gli sviluppatori a capire il vostro prodotto. In realtà, abbiamo anche esempio di codice proprio sulla nostra home page. Il suo segreto per nessuno che gli sviluppatori odiano a fare clic. Non si diffuse la documentazione su un milione di diverse pagine. Mantenere argomenti relativi vicini l'uno all'altro sulla stessa pagina. Erano grandi appassionati di lunghe guide singola pagina che consentono agli utenti di vedere il quadro generale con la possibilità di ingrandire facilmente nei dettagli con una barra di navigazione persistente. Questo ha il grande effetto collaterale che gli utenti possono cercare tutti i contenuti con un browser di ricerca in-page. Un grande esempio di questo è la documentazione Backbone. js. che ha tutto a portata di mano. Includere un delicato Quickstart La parte più difficile di adottare una nuova API è proprio all'inizio, in cui la curva di apprendimento è ripida e lo sviluppatore è esposto a nuove idee complicate. La soluzione a questo è di introdurre l'API con una guida rapida. L'obiettivo del quickstart è camminare l'utente attraverso i passi minimi necessari per fare la cosa più piccola possibile nella vostra API. Niente di più. Una volta che un utente ha fatto questo, theyre pronto a passare ai concetti più avanzati. Ad esempio, la nostra guida rapida ha all'utente di scaricare i nostri SDK e quindi salvare un oggetto alla nostra piattaforma. Abbiamo anche un pulsante che consente agli utenti di verificare se theyve fatto questo in modo corretto. Questo dà loro la fiducia necessaria per andare avanti e imparare il resto della nostra piattaforma. Utilizzare più lingue Viviamo in un mondo poliglotta. Se del caso, cercare di elencare esempi per più lingue che l'API supporta, molto probabilmente tramite librerie client. L'apprendimento di una nuova API è già abbastanza difficile senza dover analizzare lingue sconosciute. MailGuns API fa un grande lavoro di questo lasciando gli sviluppatori di scegliere tra riccio, Ruby, Python, Java, C, PHP e per gli esempi in un menu globale. Non si può mai Over-comunicare i casi limite la cosa peggiore è essere in via di sviluppo con una API solo per scoprire uno stato di errore quello non è documentato. In situazioni come questa, può essere poco chiaro se l'errore è nel codice, o nella vostra comprensione della API. Il vostro riferimento dovrebbe includere ogni caso limite e ogni ipotesi che viene fatta, implicitamente o esplicitamente. Trascorrere qualche minuto facendo questo può risparmiare ore di tempo agli utenti collettiva. Alla fine della giornata, gli sviluppatori vogliono vedere il quadro generale. E il modo migliore per dimostrare che è con applicazioni di esempio di lavoro. Trovo che il codice dell'applicazione è il modo migliore per comunicare come tutto nei tuoi legami API insieme e come si integra con altri sistemi. Un grande esempio di questo è codice di esempio in Mele iOS Developer Library. che ha una selezione esaustiva di iOS campione applicazioni organizzate per argomento. Leggendo la documentazione API isnt esattamente un emozionante giro sulle montagne russe. Ma, si può almeno aggiungere un po 'di personalità e divertimento nella vostra scrittura. Sorprendete il vostro lettore con esempi divertenti e nomi di variabili diverse foo. Questo almeno impedire loro di addormentarsi. Il modo per un cuore sviluppatori è ottima documentazione. E, ottima documentazione richiede un sacco di investimento. Ma, questo investimento è valsa la pena, ed è altrettanto importante per un prodotto sviluppatore come l'API in sé. L'altra metà di questo sta progettando un grande API in primo luogo. Ma, che sarà il tema di un altro post. Psst: Se amate API ben progettato e persone di insegnamento su di loro, sono stati assunzione di un evangelista sviluppatore a Parse. Pubblicato il 11 gennaio 2012JForex API JForex API fornisce la possibilità di sviluppare applicazioni software personalizzate utilizzando il linguaggio di programmazione Java. libreria client API può essere collegato a sistemi del cliente. Si comunica direttamente con i server commerciali Dukascopy Bank oltre sessioni Internet sicuri e autenticati. Non è necessario eseguire piattaforma JForex allo stesso tempo, ma la piattaforma può essere utilizzato per monitorare in tempo reale le misure adottate da un sistema clienti. Per iniziare a lavorare con il JForex Software Development Kit (SDK JForex), scaricare e importarlo in un Java Integrated Development Environment (IDE) di vostra scelta: Il JForex SDK contiene esempi per: la strategia in esecuzione con la strategia di dati dal vivo test retrospettivi strategia back - test in modalità visiva panoramica JForex SDK descrive come modificare e migliorare questi casi di utilizzo. Per lo sviluppo di strategia, iniziare con la panoramica API strategia. Le ultime dipendenze JForex SDK può sempre essere trovati nel repository pubblico Dukascopy Maven. il che significa che si può configurare il proprio progetto per utilizzare sempre l'ultima versione API JForex. Rimani aggiornato con i nostri più recenti sviluppi api JForex e iscriversi a e-mail automatiche JForex rilascio API di nota. Inoltre, non dimenticate di controllare il nostro supporto API forum dove sono pubblicati e discussi tutti i rilasci API JForex.