Jforex Api Documentação Padrão

Estou escrevendo uma especificação para uma API RESTful para um novo serviço interno da Web. Não é muito longo e bastante simples, mas mesmo assim, é a minha primeira vez usando REST estrito (ao contrário de trapaças por razões práticas - evitando PUT e DELETE porque eles são uma dor no PHP, e assim por diante). Eu queria saber se havia algum método padrão ou práticas recomendadas para documentar uma interface REST Eu quero que o resto da equipe a entenda de relance e para quem quiser escrever um cliente para poder fazê-lo sem entender o subjacente código. Perguntou 22 de maio 09 às 15:00 Na publicação Roys, ele afirma que A REST API deve gastar quase todo o seu esforço descritivo na definição do (s) tipo (s) de mídia usado para representar recursos e conduzir o estado da aplicação, ou na definição de nomes de relação estendidos e / ou hipertexto - marcação habilitada para tipos de mídia padrão existentes. Qualquer esforço gasto descrevendo quais métodos usar em que URIs de interesse devem ser totalmente definidos dentro do escopo das regras de processamento para um tipo de mídia (e, na maioria dos casos, já definido por tipos de mídia existentes). Respondeu 22 de maio 09 às 17:11 Gotcha. Isso também foi meu intuito: forneça explicações detalhadas sobre o que cada chamada faz. Não é o que é. Estou pensando que não existe um método padrão para fazer isso, mas, no inferno, acho que a ala nunca machucou ninguém (não me cite sobre isso). Obrigado pela ajuda. Ndash Samir Talwar 23 de maio de 09 às 0:13 Claro, as APIAS REST devem, idealmente, usar HATEOAS e ser orientadas por hipertexto (com uso intenso de tipos de mídia), mas também ter uma documentação simples e amigável para os desenvolvedores para trabalhar fora de. Algumas ferramentas específicas que são úteis para gerar documentação como esta: Swagger Uma especificação aberta para descrever APIs REST github Ferramentas para geração automática de código de documentação para sua API Mashery Um projeto de código aberto github Ferramentas para gerar documentação Uma interface de exploração para sua API Apiário e API Blueprint Escreva a descrição da API em uma DSL dentro do markdown Ferramentas para geração automática de documentação Servidor de simulação Parece estar focado no rubymac devs RAML Uma especificação para descrever as APIs REST github WADL Uma especificação para a escrita de documentos API visíveis com XML Alguma discussão comparando WSDL e WADL APIgee Um produto comercial com alguns recursos de documentação 3scale Um produto comercial com alguns recursos de documentação miredot Gerador de documentação comercial REST API Java específico atendido 12 de agosto 14 às 13:44 Na minha empresa, ficamos muito felizes usando WADL. Idioma da descrição da aplicação da Web. Wikipedia descreve como: um formato de arquivo baseado em XML que fornece uma descrição legível por máquina de aplicativos da Web com base em HTTP. Eu acho WADL bruto, fácil de escrever, ler e entender, e ele mapeia diretamente para conceitos RESTful. O projeto oficial fornece um esquema simples de especificações, XSD e RELAX NG e ferramentas Java. Existem várias ferramentas e recursos para trabalhar com WADL, incluindo: wadlstylesheets. Folhas de estilo XSLT para criar documentação HTML a partir dos arquivos WADL Restauração. Uma estrutura de Java para a construção de servidores e clientes RESTful, inclui uma extensão WADL Uma dica: tente incluir documentação legível por humanos, como descrições, conceitos, iniciação, dicas de uso, etc., no elemento do documento de documentos WADL, incluindo elementos HTML, usando O espaço para nome XHTML. Pode fazer uma grande diferença com resposta 22 de maio 09 às 17:22 Eu examinei WADL, mas parece que ele está mais orientado para a interpretação da máquina do que a documentação. Eu não preciso dizer ao computador como lidar com a API - que só precisa ser escrito uma vez. Eu preciso dizer às pessoas como escrever clientes e, portanto, as pessoas são meu público principal. Ndash Samir Talwar 22 de maio 09 às 20:59 Uma boa documentação ReST significaria documentar seu tipo de mídia e apenas seu tipo de mídia. Em um cenário típico, você deve produzir um documento como o seguinte: Os formatos XML da Acme Corp. Link Discovery Links para vários recursos são descritos em um documento que pode ser encontrado, emitindo uma solicitação GET ou HEAD para o servidor em um URI de marcador (tipicamente a raiz Do servidor, acme. org) e procurando um cabeçalho HTTP Link: onde a parte rel é a relação link e o xxx é o URI para o qual o relacionamento foi estabelecido. Relacionamentos de link Este documento define os seguintes nomes de relacionamento: rel. acme. orgservices O relacionamento de link descreve a lista de links que podem ser navegados. Rel. acme. orgcustomers O link para o qual esta relação é usada é a lista de clientes. Tipos de mídia O applicationvnd. acme. servicesxml é um documento com uma serialização xml que descreve uma lista de links que um aplicativo pode querer processar. O applcationvnd. acme. customersxml é um documento com uma serialização xml que descreve os clientes. Documentos de exemplo: o objetivo é dar uma maneira para o desenvolvedor seguir os links que você define. Primeiro, encontre o link para o índice para que eles possam obter a lista de coisas para as quais eles podem navegar. Uma vez que eles descobrem esse documento, eles descobrem que podem ver uma lista de clientes em um certo Uri, e podem fazer um GET contra isso. Se encontrarem um cliente de interesse, eles podem seguir o link definido em customerscustomerhref e emitir um GET para recuperar uma representação desse cliente. A partir daí, seu tipo de mídia pode incorporar ações que estão disponíveis para o usuário, usando mais links. Você também possui a opção adicional de emitir uma solicitação OPTIONS no recurso para saber se você pode permitir a exclusão do recurso ou um PUT se você pode salvar o documento após a modificação. Portanto, uma boa documentação nunca: dar links estáticos dão interação, como você pode emitir POST no Cliente com este tipo de mídia e isso significará a operação de movimentação. O cliente deve emitir um POST contra o Cliente apenas porque seu documento XML especificou dessa forma. O objetivo de tudo isso é conseguir o acoplamento mínimo entre clientes e servidores. O cliente pode ser muito inteligente na exibição e na descoberta de recursos (mostrando formas e Deus sabe o que mais), mas é totalmente burro quanto ao fluxo de trabalho atual: o servidor decide. Para criar documentação de entendimento, as soluções pesadas sempre são necessárias. Exemplos de ferramentas (ótimas) de peso pesado são: IODocs Apigee (embora excelentes ferramentas). Para pequenos projetos que já possuem uma configuração de docchain (doxygenphpdocphpdoctorcustometc), uso o seguinte shellscript para incluir apenas a página na documentação gerada total: ele apenas usa tags de comentários personalizadas em seu código de origem. Também pode ser um bom ponto de partida para documentar qualquer código fonte (idioma). Respondeu Jan 9 13 às 21:28 Seria preferível incluir as partes essenciais da resposta aqui e fornecer o link para referência. Ndash j0k Jan 9 13 at 21:46 Sua resposta 2017 Stack Exchange, IncPara os participantes do mercado profissional, o Dukascopy Bank oferece a possibilidade de integração de API. A Dukascopy Bank API é baseada no protocolo FIX4.4. A API é usada para receber feed de dados em tempo real, enviar ordens, definir modificar ordens de cancelamento e receber notificações automatizadas de atividades de negociação. Com uma conexão FIX API, os usuários ainda poderão usar as plataformas de negociação padrão do Dukascopy Bank com suas funcionalidades básicas. No entanto, o método de cálculo da posição (modo de posição netglobal) aplicado às contas da API FIX é diferente. REQUISITOS DE INÍCIO LIVE: condições mínimas para abrir uma conta de API - clique aqui. Esquemas de conexão de documentação Os usuários do Dukascopy Bank FIX API têm a opção de se conectar através de dois esquemas diferentes: o Esquema 1 é usado para conexões diretas para uma única conta do Banco Dukascopy sem compartilhar dados com nenhum software de solução de terceiros. O Esquema 2 permite conexões mais complexas que envolvem várias contas bancárias da Dukascopy ou o uso de alguns bancos de dados de terceiros. Para saber mais sobre a API FIX e outras informações relacionadas à negociação, escreva-nos: infoducascopia. Ligue-nos: 41 22 799 4888 ou, em alternativa, peça um call-back.