A Mashery anunciou a abertura do código de seu Mashery I/O Docs, um sistema de documentação para gerar informações interativas sobre como APIs Web funcionam. O I/O Docs foi inspirado pelas referências da API do site Posterous e pela documentação do Wordnik. Exemplos de uso do I/O Docs estão disponíveis para as APIs Alibris e Klout.
Uma vez que a documentação é gerada e carregada em um navegador, as várias chamadas da API são listadas em uma página, em forma de referência rápida. Ao clicar em qualquer referência, sua entrada se expande para mostrar os parâmetros da chamada. Esses parâmetros não são passivos, eles possuem campos para a inserção de valores, um seletor para resultados em formato XML ou JSON, e um botão "Try It" (Experimentar) que fará a requisição do chamado da API com os parâmetros mostrados. Além disso, ele mostrará todo o procedimento da chamada, com o cabeçalho e corpo da resposta.
Esse formato permite que desenvolvedores experimentem com APIs para ganhar um melhor entendimento de como funcionam. O sistema em código aberto, escrito como um aplicativo Node.js, está disponível para download no Githubsob uma licença similar à MIT Licence. O I/O Docs não automatiza a criação da documentação e requer que o desenvolvedor crie arquivos JSON que contêm informações sobre como a API a ser documentada opera. I/O Docs também suporta autenticação por chave e por OAuth, para acesso à documentação de APIs restritas.
Fonte: h-online, em inglês.
0 comentários:
Postar um comentário