Executando verificação de segurança...
5
pultzlucas
1 min de leitura ·

Boas práticas ao criar APIs REST

Porque utilizar boas práticas?

Para desenvolver uma API REST é necessário saber de algumas boas práticas que podem tornar o processo de desenvolvimento mais rápido, organizado e de fácil implementação. Afinal, utilizar más práticas pode aumentar a complexidade e atrasar o desenvolvimento do projeto, além de comprometer a qualidade do seu backend.

Boas práticas que devem ser incluídas ao desenvolver um projeto de API REST

  • Verificar a entrada de dados e fazer os tratamentos necessários antes de cadastrá-los em alguma base de dados, isso inclui a cryptografia de senhas e dados sensíveis dos usuários;
  • Fazer o tratamento de todas os possíveis exceções que podem ocorrer dentro da aplicação, com retorno dos códigos HTTP referentes ao tipo do erro. Além de adicionar no corpo de response de erro uma mensagem descrevendo o motivo da exceção;
  • Utilizar os métodos de requisição HTTP da forma correta. Para saber mais clique aqui.
  • Retornar no objeto JSON/XML apenas com os dados que serão utilizados pelo frontend
  • No caso de APIs privadas. Usar chaves de acesso para autenticar os usuários para evitar invasões e exposição de dados.
  • Escrever a documentação da API para auxiliar o usuário, inclusive os tipos dos campos de cada rota. Existem diversas plataformas para automatizar a geração de documentação, como o Postman, Insomnia e Swagger.

(^-^)

Carregando publicação patrocinada...
2
0
1
CarlosNogueira

Em complementação ao tratamento de todas as possíveis excessões, é altamente recomendado dar um feedback para o desenvolvedor do resultado final da requisição:
2xx (Sucesso);
4xx (Erro do lado do cliente);
5xx (Erro no servidor);
Dentre outros.

Em conjunto com o código de status HTTP é essencial compor o retorno de uma situação de erro com um corpo em formato JSON pré-definido e uma mensagem descrevendo precisamente a causa da exceção.

#RUIM
{
"error": "Um erro ocorreu",
"message": "Um erro ocorreu"
}

#BOM
{
"error": "Nao encontrado",
"message": "O produto com ID 217 não foi encontrado"
}

1