Perguntas com a marcação «api-design»

O design da interface de programação de aplicativos (API) discute as práticas recomendadas para criar bibliotecas destinadas a uso geral ou público.

322
Você deve escrever seu back-end como uma API?

Hoje tive uma discussão acalorada sobre nosso aplicativo MVC. Temos um site escrito em MVC ( ASP.NET ) e, geralmente, segue o padrão de fazer algo na exibição -> pressionar o controlador -> o controlador cria um modelo (chama um gerente que obtém os dados, cria o modelo no diretório próprio...

48
Por que o método PATCH não é idempotente?

Eu estava pensando sobre isso. Suponha que eu tenha um userrecurso com ide namecampos. Se eu quiser atualizar um campo, poderia fazer uma solicitação PATCH para o recurso como este PATCH /users/42 {"name": "john doe"} E então o aplicativo atualizará o nome do usuário 42. Mas por que, se eu...

45
Quão necessário é seguir práticas defensivas de programação para códigos que nunca serão disponibilizados ao público?

Estou escrevendo uma implementação Java de um jogo de cartas, então criei um tipo especial de coleção que estou chamando de zona. Todos os métodos de modificação do Java's Collection não são suportados, mas há um método na API da região move(Zone, Card), que move um cartão da região em questão para...

42
O que há de tão ruim no DOM?

Continuo ouvindo pessoas (Crockford em particular) dizendo que o DOM é uma API terrível, mas não justificando realmente essa afirmação. Além das inconsistências entre navegadores, quais são algumas das razões pelas quais o DOM é considerado tão

41
Por que java.util.ArrayList permite adicionar nulo?

Eu me pergunto por que java.util.ArrayListpermite adicionar null. Existe algum caso em que eu gostaria de adicionar nulla um ArrayList? Estou fazendo essa pergunta porque, em um projeto, tivemos um bug em que algum código estava sendo adicionado nullao arquivo ArrayListe era difícil identificar...

37
API REST - A API deve retornar objetos JSON aninhados?

Quando se trata de APIs JSON, é uma boa prática achatar respostas e evitar objetos JSON aninhados? Como exemplo, digamos que temos uma API semelhante à IMDb, mas para videogames. Existem algumas entidades, Game, Platform, ESRBRating e GamePlatformMap, que mapeiam Jogos e Plataformas. Digamos que...

33
Uma API HTTP sempre deve retornar um corpo?

Existe algum tipo de padrão em relação às respostas da API HTTP? Depois de ler este tópico do discurso , comecei a me perguntar. Estamos desenvolvendo nossa API HTTP JSON pública no meu trabalho e não retornamos nada quando não é estritamente necessário (por exemplo, um PUT para / resource / {id}...