Werner Vogels – 6 lições aprendidas para um bom design de API

 (aws.amazon.com)
30 pontos por xguru 2022-01-26 | 4 comentários | Compartilhar no WhatsApp
  • Anotações sobre os "6 princípios para criar boas APIs que a AWS aprendeu ao longo de 15 anos"

  1. APIs são para sempre!

  2. Preserve a compatibilidade retroativa.

  3. Construa de trás para frente a partir dos casos de uso dos clientes.

  4. Crie APIs em que os erros sejam explícitos.

  5. Crie APIs cujo propósito e modo de uso possam ser compreendidos imediatamente.

  6. Tome cuidado para que os detalhes de implementação não vazem.

  • Erros cometidos no design inicial de APIs

  • Criando APIs altamente escaláveis com Smithy

Leituras relacionadas

4 comentários

 
xguru 2022-01-30
 
edunga1 2022-01-26

Para mim, o 5º ponto foi o que mais chamou atenção.

Eu já tinha visto o artigo referenciado, "Será que essa REST API está boa mesmo?", e gostei bastante: https://tv.naver.com/v/2292653

Normalmente não ligo muito para esse tipo de informação semântica, mas quando vejo a API do GitHub, ela também entrega bem esse tipo de informação, então dá a sensação de que foi muito bem feita.
 
ehlegeth 2022-01-26

Parece um conteúdo muito bom.

Especialmente os itens 1 e 4 parecem ser pontos que eu sempre menciono ao fazer uma revisão.

O item 3 parece tocar no mesmo ponto de Joshua Bloch quando ele disse "Write to Your API Early and Often". (https://www.youtube.com/watch?v=aAb7hSCtvGw)
 
nicewook 2022-01-26

Quando organizamos assim, parece algo óbvio, mas também dá a impressão de que, na prática, acabamos repetindo os mesmos erros.