Eu já tinha terminado todos os testes de API com Swagger ou Postman, mas achei repetitivo e ineficiente ter que digitar a documentação manualmente no Notion, então criei isto.
O que criei: ao enviar qualquer arquivo Swagger/OpenAPI(.json, .yaml), Postman Collection(.json) ou Insomnia Export(.json), ele converte automaticamente para uma documentação em Markdown com endpoints, parâmetros e exemplos de requisição/resposta organizados. É só copiar e colar no Notion ou baixar como arquivo .md e colocar no repositório.
Como experimentar: ao acessar o link acima, a tela de upload aparece direto. Mesmo que você não tenha um arquivo, há botões de arquivos de exemplo por formato na tela, então dá para conferir o resultado com apenas um clique.
Quais são os diferenciais: já vi ferramentas parecidas que suportam apenas Swagger, mas era difícil encontrar uma que também fizesse o parsing de arquivos exportados do Postman/Insomnia e os convertesse para um formato unificado, então defini esse ponto como diferencial. Ela identifica automaticamente o formato analisando o conteúdo do arquivo.
Ainda não há recurso de login, e no caso do Insomnia ainda não é possível trazer até as respostas de exemplo; é uma fase inicial de MVP. Se você testar de verdade e tiver algum ponto incômodo ou sugestões de outros formatos que gostaria que fossem suportados, fique à vontade para deixar nos comentários.
Deixei aqui um texto explicando um pouco mais por que criei isto: https://velog.io/@dkslasdud/…
Ainda não há comentários.