UnifespCodeLab / plasmedis-api

0 stars 0 forks source link

Revisar Status Codes #1

Closed dsalexan closed 1 year ago

dsalexan commented 2 years ago

História de Usuário

Revisar todos os endpoints da api, e refatorar o código para padronizar os status codes nas respostas dos endpoints e a estrutura de resposta.

Resumo

Atualmente as respostas dos endpoints não estão padronizadas. As vezes é um objeto com "success: True", outras só com uma mensagem de erro ou sucesso.

api > controller > users.py > @users.route("")

{"success": False, "message": e.message}

api > controller > users.py > @users.route("")

{"message": f"Dados de {user['username']} removidos"}

api > controller > users.py > @users.route('/')

{"success": True, "message": f"Usuario criado", "user": id}

A ideia é padronizar todas as respostas (o que vai envolver modificações em models > reponses também, já que cada resposta tem um schema). As respostas tem que ter um status code correspondente (200 para sucesso, 404 para recurso não encontrato, 401 para acesso nao autorizado, etc..). Checar os links em Informações Adicionais para referência.

Critérios de Aceite

Protótipo

Informações Adicionais

https://moz.com/learn/seo/http-status-codes https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

dsalexan commented 1 year ago

7