Adicionar documentação das rotas do Laguinho

OpenDevUFCG / laguinho-api

Onde todos os dados, pessoas e radiação da UFCG se encontram.

MIT License

28 stars 18 forks source link

Adicionar documentação das rotas do Laguinho #55

Open lucasmedeiros opened 5 years ago

lucasmedeiros commented 5 years ago

É 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 commented 5 years ago

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

lucasmedeiros commented 5 years ago

@ItaloSa Claro! :smile:

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

paulojbleitao commented 5 years ago

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

JoseRenan commented 5 years ago

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 :thinking: mas a gente poderia pensar em algo mais bonitinho também, como o https://docusaurus.io ou um https://swagger.io/ da vida :thinking: o que acham?