Exemplos de documentação do jforex api

Projetando excelente documentação da API Docs A documentação é uma das coisas que tem muitos desenvolvedores. É preciso muito esforço e tempo para ficar correto. E muitas vezes, as pessoas tomam atalhos. Isso é triste porque a documentação bem desenhada é a chave para despertar as pessoas sobre seu projeto, seja seu código aberto ou um produto focado no desenvolvedor. Na verdade, eu argumento que a peça mais importante da UX para um produto de desenvolvedor não é a página inicial ou o processo de inscrição ou o download do SDK. É a documentação da API Quem se importa se o seu produto é a coisa mais poderosa do mundo se ninguém entender como usá-lo. Se você estiver fazendo um produto focado no desenvolvedor, a documentação é tão fundamental para a experiência do usuário como os próprios pontos de extremidade. Eu vi muitos projetos que simplesmente despejaram você em uma página do GitHub com um readme de dois leitores. Os documentos API mais bem sucedidos são cuidadosamente criados com amor. Aqui, na Parse, nos dedicamos a esta arte. Então, quais os elementos que fazem na documentação da API excelente. Documentação é uma Bússola em camadas. Sua documentação não deve ser apenas uma lista simples de pontos finais com seus parâmetros. A documentação é um ecossistema completo de conteúdo que visa ensinar os usuários a interagir com sua API. No mínimo, você deve ter esses componentes: Referência: Esta é a listagem de toda a funcionalidade em detalhes insatisfatórios. Isso inclui todas as especificações de tipo de dados e função. Seus desenvolvedores avançados deixarão isso aberto em uma guia durante todo o dia. Guias: isso está em algum lugar entre a referência e os tutoriais. Deve ser como sua referência com prosa que explica como usar sua API. Tutoriais: estes ensinam as coisas específicas de seus usuários que podem fazer com sua API, e geralmente são focados em apenas algumas peças de funcionalidade. Pontos de bônus se você incluir código de exemplo de trabalho. Na Parse, nós temos todos os três desses componentes, e atualmente estamos trabalhando na criação de mais tutoriais. Remova Abstrações com Exemplos Você poderia argumentar que sua API é uma grande abstração, e esse é o tipo de ponto. No entanto, ao ensinar desenvolvedores, tente remover o máximo de abstrações possível. Polvilhe alegremente exemplos do mundo real ao longo de sua documentação. Nenhum desenvolvedor nunca se queixa de que há muitos exemplos. Reduzem drasticamente o tempo para que os desenvolvedores entendam seu produto. Na verdade, até temos um código de exemplo diretamente na nossa página inicial. Não é nenhum segredo que os desenvolvedores odeiam clicar. Não espalhe sua documentação em um milhão de páginas diferentes. Mantenha tópicos relacionados próximos uns dos outros na mesma página. Foram grandes fãs de longos guias de páginas únicas que permitiram que os usuários vejam a imagem com a capacidade de ampliar facilmente os detalhes com uma barra de navegação persistente. Isso tem o grande efeito colateral de que os usuários podem pesquisar todo o conteúdo com uma pesquisa no navegador da página. Um excelente exemplo disso é a documentação do Backbone. js. Que tem tudo ao seu alcance. Incluir um Quickstart suave A parte mais difícil de adotar uma nova API é exatamente no início, onde a curva de aprendizado é íngreme e o desenvolvedor está exposto a novas idéias complicadas. A solução para isso é apresentar a API com um guia de inicialização rápida. O objetivo do quickstart é andar pelo usuário através das etapas mínimas necessárias para fazer a menor coisa possível em sua API. Nada mais. Uma vez que um usuário tenha feito isso, eles estão prontos para seguir os conceitos mais avançados. Por exemplo, nosso guia de início rápido tem o usuário baixar nossos SDKs e, em seguida, salvar um objeto em nossa plataforma. Nós até temos um botão que permite que os usuários verifiquem se eles fizeram isso corretamente. Isso lhes dá a confiança para seguir em frente e aprender o resto da nossa plataforma. Use várias línguas. Moramos em um mundo poliglota. Se for o caso, tente listar exemplos para vários idiomas que sua API oferece, provavelmente através de bibliotecas de clientes. Aprender uma nova API é suficientemente difícil sem ter que analisar linguagens desconhecidas. O MailGuns API faz um ótimo trabalho ao permitir que os desenvolvedores escolham entre curl, Ruby, Python, Java, C e PHP para os exemplos em um menu global. Você nunca pode se sobrecarregar de casos de borda O pior é estar desenvolvendo com uma API apenas para descobrir um estado de erro que não está documentado. Em situações como esta, não pode ser claro se o erro está no seu código ou na sua compreensão da API. Sua referência deve incluir cada caso de borda e cada pressuposição que seja feita, de forma implícita ou explícita. Passar alguns minutos fazendo isso pode economizar horas do tempo coletivo de seus usuários. No final do dia, os desenvolvedores querem ver o quadro geral. E a melhor maneira de mostrar isso é com aplicações de amostra de trabalho. Eu acho que o código do aplicativo é a melhor maneira de comunicar como tudo em sua API se liga e como ele se integra com outros sistemas. Um excelente exemplo disso é o código de exemplo na Apples iOS Developer Library. Que possui uma seleção exaustiva de aplicativos iOS de exemplo organizados por tópico. A leitura da documentação da API não é exatamente uma emocionante montanha russa. Mas, você pode, pelo menos, adicionar alguma personalidade e diversão à sua escrita. Surpreenda seu leitor com exemplos engraçados e nomes de variáveis ​​que não sejam foo. Isso, pelo menos, os impedirá de adormecerem. O caminho para o coração de um desenvolvedor é uma ótima documentação. E, ótima documentação requer muito investimento. Mas, esse investimento vale a pena e é tão importante para um produto de desenvolvedor como a própria API. A outra metade disso é projetar uma excelente API em primeiro lugar. Mas, esse será o tema de outra publicação. Psst: Se você gosta de APIs bem projetadas e ensinando pessoas sobre elas, estavam contratando um Evangelista Desenvolvedor na Parse. Postado em 11 de janeiro de 2017JForex API A JForex API oferece a possibilidade de desenvolver aplicativos de software personalizados usando a linguagem de programação Java. A biblioteca do cliente da API pode ser vinculada aos sistemas do cliente. Ele se comunica diretamente com os servidores comerciais do Dukascopy Bank através de sessões de Internet seguras e autenticadas. Não é necessário executar a plataforma JForex ao mesmo tempo, mas a plataforma pode ser usada para monitorar em tempo real quaisquer ações tomadas por um sistema de clientes. Para começar a trabalhar com o Kit de Desenvolvimento de Software JForex (JForex SDK), baixe-o e importe-o em um Ambiente de Desenvolvimento Integrado Java (IDE) de sua escolha: O JForex SDK contém exemplos para: estratégia executada com estratégia de back-testing da estratégia de dados ao vivo back - Teste no modo visual A descrição geral do JForex SDK descreve como modificar e melhorar esses casos de uso. Para o desenvolvimento da estratégia, comece com a visão geral da API da Estratégia. As últimas dependências do JForex SDK sempre podem ser encontradas no repositório público Dukascopy Maven. O que significa que se pode configurar seu projeto para usar sempre a versão mais recente da API JForex. Mantenha-se atualizado com os nossos últimos desenvolvimentos da JDIx api e assine os e-mails automáticos da nota de lançamento da Jforex API. Além disso, não se esqueça de verificar o nosso fórum de suporte da API onde todos os lançamentos da Jforex API são publicados e discutidos.