O maior problema que tive quando aprendi a programar minhas próprias estratégias de negociação no JForex é encontrar onde começar a aprender. Havia poucas documentações da JForex disponíveis na época e tive que me ensinar por meio de tentativa e erro com a ajuda do suporte técnico da Dukascopys. As coisas certamente mudaram para melhor, já que uma comunidade JForex está começando a brotar e a documentação, pelo menos, é suficiente para começar alguém. Este post é o primeiro de uma série de guia rápido de iniciantes para aprender programação JForex, colocando todos esses recursos em um tutorial. JForex é uma ferramenta Java JForex não é realmente uma linguagem de programação. É uma interface de programação de aplicativos (API) para uso com a linguagem de programação Java padrão. Como tal, o primeiro passo para aprender a programar no JForex é aprender Java. Felizmente, o Java é uma das linguagens de programação mais populares. Há muitos recursos dentro e fora da web para aprender programação Java. Alguns exemplos de tutoriais on-line gratuitos são: The Java Tutorials - Este é um tutorial oficial do próprio desenvolvedor Java. Altamente recomendado. Beginners Java Tutorial - Mais voltado para iniciantes na programação. Se você preferir um livro, eu recomendaria Head First Java, 2nd Edition. Eu escovei meu Java deste livro. Não pense muito em Java, pois você só precisa saber o básico para começar a usar o JForex. Basta ler alguns capítulos para entender a sintaxe Java e seguir em frente. Você sempre pode se referir a eles mais tarde. Mergulhando no JForex O Wiki do JForex é um dos três recursos essenciais para os programadores do JForex. Vou me referir a algumas páginas específicas do Wiki em grande parte desta série de posts. Se ainda não o fez, inscreva-se para uma conta DEMO na Dukascopy. Em seguida, inicie a plataforma JForex e siga as instruções na página Wiki Use in JForex para montar sua primeira estratégia JForex Resumo Até agora, tudo bem. Até este ponto, espero que você possa entender o código fonte Java básico e saber como iniciar / abrir, compilar, e executar uma estratégia JForex. No próximo post desta série de aprendizado da JForex, estudaremos a anatomia de uma estratégia JForex. Por que escrever a documentação de referência da API. Se sua empresa desenvolve APIs, você pode fornecer documentação de referência para cada API disponível com o produto. A documentação da API deve descrever os componentes comuns usados por cada uma das APIs para iOS, Android e outras plataformas. Essencialmente, a documentação de referência da API explica as estruturas de dados disponíveis por meio das APIs. Se estiver bem escrito, isso aumentará o uso e a popularidade de suas APIs e incentivará os desenvolvedores, testadores e integradores a usar seus produtos da API. Mas o que é uma API O que é uma API Uma interface de programação de aplicativo (API) é uma interface implementada por um programa de software para permitir a interação com outro software, da mesma forma que uma interface de usuário facilita a interação entre humanos e computadores. As APIs são implementadas por aplicativos, bibliotecas e sistemas operacionais para determinar o vocabulário e as convenções de chamada que o programador deve empregar para usar seus serviços. Pode incluir especificações para rotinas, estruturas de dados, classes de objeto e protocolos usados para comunicação entre o consumidor e o implementador da API. Conceito da Wikipédia Uma API é uma abstração que define e descreve uma interface para a interação com um conjunto de funções usadas pelos componentes de um sistema de software. O software que fornece as funções descritas por uma API é considerado uma implementação da API. Genérico o conjunto completo de API que são empacotados nas bibliotecas de uma linguagem de programação (por exemplo, a Biblioteca de modelos padrão em C ou a API Java) Específica destinada a resolver um problema específico, como a API do Google Maps ou a API Java para XML Web Services . Dependente de linguagem disponível apenas em uma determinada linguagem de programação. Ele está disponível apenas usando a sintaxe e os elementos dessa linguagem para tornar a API conveniente para uso neste contexto. Linguagem independente escrita de uma maneira que significa que pode ser chamada a partir de várias linguagens de programação. Esse é um recurso desejado para uma API orientada a serviços que não está vinculada a um processo ou sistema específico e pode ser fornecida como chamadas de procedimento remoto ou serviços da web. Por exemplo, um website que permite que os usuários analisem restaurantes locais é capaz de colocar em camadas suas resenhas em mapas tirados do Google Maps, porque o Google Maps tem uma API que permite isso. A Google Maps8217 API controla quais informações um site de terceiros pode capturar e o que pode ser feito com elas. O 8220API8221 pode ser usado para se referir a uma interface completa, uma única função ou até mesmo um conjunto de várias APIs fornecidas por uma organização. Assim, o escopo do significado é geralmente determinado pela pessoa ou documento que comunica as informações. Benefícios da Documentação da API Incentive a adoção da plataforma, pois os desenvolvedores poderão modificar o código mais rapidamente Reduz os custos de suporte ao cliente, pois os desenvolvedores podem encontrar as respostas que precisam Permitir que os programadores se concentrem na codificação APIs e incluir, se possível, diagramas Como começar a explicar como começar e outros tutoriais que ajudam a orientar o leitor, por exemplo, configurando autenticação e tokens de acesso O material de referência define o objetivo de cada recurso. configuração e parâmetro no código. Inclua valores padrão e outras informações que ajudem o leitor. Código de exemplo este é o que é de maior interesse para o desenvolvedor. Inclua exemplos de código que tenham muitos comentários detalhados para que eles possam entender como cada parâmetro funciona. Forneça valores e exemplos padrão Como começar Forneça muitas amostras de código, desde aplicativos hello world até exemplos mais complexos. O principal é ajudá-los a começar. Os tutoriais também fazem isso. Acompanhe-os em casos de uso simples e adicione mais camadas de complexidade para que eles trabalhem na API. Diretrizes de código de exemplo Fornece código de exemplo que o desenvolvedor pode usar para começar. Os desenvolvedores aprendem fazendo codificação sem ler. Então, dê a eles um monte de código de exemplo para começar. Amostras de código devem conter as seguintes seções. Visão geral explica o objetivo deste exemplo de código. Uma frase é geralmente suficiente. Requisitos para executar o exemplo de código Demonstra o que acontece quando você executa o código Exemplo de código detalhado de código de amostra com comentários Criar código de amostra usando as seguintes diretrizes: Comentários Fornecer comentários para cada método, parâmetro ou configuração que precise de explicação. Use comentários em qualquer lugar que o código não seja óbvio, especialmente se você precisar documentar uma solução alternativa ou algo incomum. Comentários podem ter várias linhas longas, se necessário. Use frases completas e não tenha medo de ser prolixo. Material de referência A maior parte da documentação da API é material de referência. É aqui que você documenta os detalhes específicos de cada recurso, método, parâmetro, bem como valores e exceções padrão. O material de referência, no mínimo, descreve o seguinte: Objetivo do item, por exemplo, solicitar parâmetros Valores padrão Valores de retorno Exceções Recomendações Referências cruzadas a outras informações úteis Exemplos de código Como gravar documentação da API Free eBook Clique aqui se você quiser 16 páginas Como escrever um documento sobre API que explica como escrever cada seção na documentação de referência da API. Ele inclui textos explicativos úteis que orientam o processo de documentação de cada seção na API, incluindo os parâmetros, pontos de extremidade, solicitações, respostas e pontos de extremidade. A criação de uma camada de API de back-end apresenta uma nova camada de coordenação entre servidor e cliente código. Embora existam muitos aspectos para essa delicada dança da comunicação, um ingrediente-chave para minimizar as confusões - sobre o que é chamado, o que é - está se comunicando consistentemente sobre os endpoints da sua API. Isso não é de forma alguma ciência de foguetes, mas com o tempo eu criei um modelo que agora costumo usar e que fui solicitado a compartilhar. Convenientemente, quando chega a hora de publicar uma API externamente, isso serve como uma ferramenta inestimável para a criação de documentação pública. Você pode ver o modelo de remarcação ao lado de um exemplo nesta essência. O nome da sua chamada de API Exemplo. Mostrar todos os usuários Observação: tente usar verbos que correspondam ao tipo de solicitação (busca versus modificação) e pluralidade (uma contra múltipla). Observação: adicione também informações adicionais, como uma descrição, se necessário. A estrutura da URL (somente caminho, sem URL raiz) / users ou / users /: id ou / usersid: id Para URLs fixos: / users ou / photos Para URLs com parâmetros neles: / users /: id ou / photos /: photoid ou / usersid: id O tipo de solicitação GET POST DELETE PUT Se houver parâmetros de URL, especifique-os de acordo com o nome mencionado na seção URL. Separar em opcional e obrigatório. Obrigatório: idinteger example: id12 Exemplo opcional de foto-numérico: photoid2345kj3 Se estiver fazendo uma solicitação de postagem, como deve ser a carga útil do corpo Este também é um bom momento para documentar suas várias restrições de dados. Exemplo: Exemplo: Qual deve ser o código de status para o sucesso e há algum dado retornado Isso é útil quando as pessoas precisam saber o que os retornos de chamada devem esperar Exemplo: Código: 200 Conteúdo: A maioria dos terminais terá muitas maneiras de falhar. De acesso não autorizado, a parâmetros impróprios, etc. Todos esses devem ser listados aqui. Pode parecer repetitivo, mas ajuda a impedir que suposições sejam feitas onde não deveriam. Exemplo: Código: 401 Conteúdo NÃO-AUTORIZADO: OR Código: 422 Conteúdo de entrada não processável: apenas uma chamada de amostra para seu terminal em um formato executável (chamada. ajax ou uma solicitação de curl) 8211 isso torna a vida mais fácil e previsível. É aqui que todas as incertezas, comentários, discussões etc. podem ir. Eu recomendo o registro de data e hora e identificar-se ao deixar comentários aqui. Existem outros aspectos de seus endpoints da API que você tende a comunicar Quais informações adicionais devem ser compartilhadas Publicado por Irene Ros em 22 de agosto de 2012
No comments:
Post a Comment