Adicionar documentação das rotas do Laguinho

[lucasmedeiros]

É necessário adicionar documentação das rotas disponibilizadas pela API (código da branch development, para mais informações consulte a issue de reformulação do laguinho), seguindo o PEP8. No momento, as rotas que temos são:

• GET /datasets: rota para recuperar todos os conjuntos de dados publicados.
• POST /datasets: rota para cadastrar/publicar um novo conjunto de dados de um repositório no Github.
• GET /datasets/nome_dataset: rota que recupera informações (metadados) de um conjunto de dados publicado a partir de seu nome.

[ItaloSa]

Olá, gotaria de ajudar. Posso pegar essa issue? Também gostaria de participar da discussão, haha 😄

[lucasmedeiros]

@ItaloSa Claro! 😄

Qualquer dúvida/sugestão que tiver, pode falar comigo por essa issue. Vou te dar assign, ok?

[paulojbleitao]

Olá @ItaloSa, se estiver precisando de ajuda ou estiver com dúvidas só falar! Costumamos discutir pelo discord, entra lá 😉

[JoseRenan]

Acho que ficou meio em aberto também como a gente pensava em fazer a documentação, mas é mais porque estamos abertos a sugestões também. Na antiga versão do laguinho, a gente tava colocando tudo nums readme mesmo 🤔 mas a gente poderia pensar em algo mais bonitinho também, como o https://docusaurus.io ou um https://swagger.io/ da vida 🤔 o que acham?