Problemas na API

[filipealvess]

@felipealencar @JoaoViniciusLima @lopesmayk

Tô preocupado com algumas coisas na API...

Imagino que, se a gente seguir implementando novas funcionalidades, vamos acabar tendo um retrabalho insuportável num futuro breve pra corrigir os diversos problemas que temos e que provavelmente o código atual vai causar.

Queria expor aqui alguns pontos que vejo como "problemas". Não é uma batida de martelo, é uma abertura de discussão, então peço que mostrem vossas opiniões pra gente ter uma discussão bacana que possa fazer nossa plataforma evoluir ✌🏻🙃

Vou separar em "melhorias gerais", que servem pra várias rotas ou partes da API, e alguns pontos específicos de algumas funcionalidades:

[filipealvess]

Melhorias gerais:

• Utilizar um middleware para verificação dos parâmetros obrigatórios
• Separar agendamentos de zonas de irrigação (rotas e controlador)
• Descrever as mensagens de feedback de forma mais específica
• Utilizar o estado 500 no retorno final (no except) dos métodos (alguns estão retornando 400)
• Separar comunicação MQTT de HTTP

[filipealvess]

Cadastro de culturas

• Utilizar apenas JSON, eliminando o uso de form data
• Retornar imagem da cultura
• Informar coordenadas como array, não como string

Exclusão de culturas

• Alterar rota para DELETE /cultures/<id>
• ID da cultura deve ser passado na rota, não no corpo da requisição
• Excluir também todos os sensores e leituras pertencentes à cultura

[filipealvess]

Atualização de zonas de irrigação

• Alterar rota para PATCH /irrigation-zones/<id>
• ID da zona deve ser passado na rota, não no corpo da requisição
• O retorno deve conter os dados atualizados, não apenas o ID e a mensagem
• Não pode receber o ID do usuário, senão ele pode ser atualizado, causando problemas nos relacionamentos das entidades

Exclusão de zonas de irrigação

• Alterar rota para DELETE /irrigation-zones/<id>
• ID da zona deve ser passado na rota, não no corpo da requisição
• Excluir também todos os sensores e leituras pertencentes às culturas que estão na zona a ser excluída

[filipealvess]

Atualização de agendamentos

• Alterar rota para PATCH /schedules/<id>
• ID do agendamento deve ser passado na rota, não no corpo da requisição
• O retorno deve conter os dados atualizados, não apenas o ID e a mensagem
• Não pode receber o ID da zona, senão ele pode ser atualizado, causando problemas nos relacionamentos das entidades

[filipealvess]

Acionamento manual de irrigação (toggle_irrigation)

• O método deveria ser PATCH, não GET, já que a rota realiza uma alteração parcial dos recursos
• Deve-se exigir o token, já que é uma ação de grande impacto

[lopesmayk]

Podemos marcar uma call para segunda ou terça feira se vcs concordarem @filipealvess @JoaoViniciusLima

[felipealencar]

Acionamento manual de irrigação (toggle_irrigation)

• O método deveria ser PATCH, não GET, já que a rota realiza uma alteração parcial dos recursos
• Deve-se exigir o token, já que é uma ação de grande impacto

Só lembrando que o toggle_irrigation surgiu naquela semana de deadline de apresentação do projeto funcional. E o toggle_irrigation por vezes pode ser chamado direto pelo sistema do circuito, que talvez não tenha implementação de todos os verbos HTTP.

[filipealvess]

Tô ligado, @felipealencar... como dizem: "feito é melhor que perfeito" 😄

Mas, agora com mais tempo, acho que a gente precisa pensar um pouco mais sobre essa funcionalidade...

Talvez, dependendo do propósito e das regras de negócio, dê pra gente colocar isso na divisão dos protocolos que eu mencionei:

Separar comunicação MQTT de HTTP

Enfim, vamos vendo isso aos poucos ✌🏻