Quer gerar códigos prontos para consultas à API´S ? Use o Swagger Editor
Se usar o Swagger para fazer a documentação de uma API já era uma mão na roda na hora de produzir documentação (conheça mais no meu artigo Documentando API com Swagger ).
Esse pessoal não para de facilitar nossa vida de Desenvolvedores ! Conheci nesta semana uma feature que eu não sabia existir, que é o Editor Swagger (não devo omitir os créditos para meu colega de trabalho Willian que me mostrou).
Esta ferramenta é capaz de ler e interpretar a documentação Swagger da sua API, e assim criar código para você consumir estas API´S em diversas linguagens, e também montar todos os objetos que você precisa !
Poxa, então agora os Dev´s vão ficar muito preguiçosos ? Não posso me esquecer daquele carinhoso apelido de T-Rex (braço curto) que já vi aplicarem num colega que não gostava de fazer documentação, imagine agora se essa ferramenta ajudar a criar códigos ! Acredito que tempo é dinheiro e eficiência é essencial para nos destacarmos no mercado tão diversificado e disputado dos dias de hoje !
Bom, então vamos ver como ela funciona !
Toda API bem construída, deve ter sua documentação Swagger, faz parte do processo implementá-la para que quem for consumir possa ter toda a referência necessária.
Então com a API exibindo a sua documentação, você terá uma tela assim, clique na opção que gera a documentação em formato JSON conforme indica a seta na figura.
Feito isso, a documentação será exibida, clique no botão “RAW” para que ela seja exibida em formato RAW.
Feito isso, copie o objeto Json exibido para enviarmos para a ferramenta.
Agora é a hora de acessarmos a ferramenta, abra uma nova aba no seu navegador e digite o endereço: https://editor.swagger.io/
Pronto, o editor será carregado
Por padrão, ele traz um exemplo de uma PetStore, você vai limpar a tela e inserir o objeto JSON copiado anteriormente.
Ao clicar em COLAR vai aparecer uma pergunta se você deseja converter o JSON para o formato YAML, clique em OK (figura abaixo).
Após colar o seu código JSON, você verá algo similar à tela abaixo, onde ele já entendeu a sua documentação, então é só acessar um dos menus desejados e criar o seu código.
Temos o menu: Generate Client com todas estas linguagens
e o Generate Server
Podemos ver que existem inúmeras opções de linguagens para podermos gerar o código !
Fiz alguns testes para ver como se comportava, e é muito interessante mesmo, que ele já nos fornece um código zipado com gitignore, readme, e documentação !
e esse código aberto no Visual Studio já nos traz as classes prontinhas para as respostas do serviço e uma implementação básica para uso da API, obviamente que teremos que refatorar várias coisas, mas o trabalho maior que era de gerar estes objetos já foi feito !
Espero assim ajudar à todos vocês nessa jornada de Dev´s com uma ferramenta muito top e que vai dar uma performance muito maior no seu trabalho !
