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

Temos uma função de API que divide um valor total em valores mensais com base nas datas de início e término. // JavaScript function convertToMonths(timePeriod) { // ... returns the given time period converted to months } function getPaymentBreakdown(total, startDate, endDate) { const numMonths = convertToMonths(endDate - startDate); return { …

38 api-design 

Estou propondo alterações em um projeto de software muito mal arquitetado que sofre de uma infinidade de problemas. Em um nível alto, o projeto utiliza Angular no front-end e consome várias APIs REST; o que é ótimo (não vejo a necessidade de mudar nossa tecnologia ou ferramentas). O problema é …

37 rest  api-design  enterprise-architecture 

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 você solicite / game / …

37 design  rest  api-design  json 

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 …

33 rest  api-design  http 

Em uma discussão sobre métodos estáticos e de instância, eu sempre penso que Sqrt()deveria ser um método de instância de tipos numéricos em vez de um método estático. Por que é que? Obviamente, funciona com um valor. // looks wrong to me var y = Math.Sqrt(x); // looks better to …

31 programming-languages  language-design  history  api-design  math 

Estou projetando um aplicativo usando microsserviços e não tenho certeza do melhor mecanismo a ser usado para coletar dados de vários serviços. Eu acredito que existem duas opções: Integre um mecanismo de comunicação entre serviços que permita que os serviços conversem diretamente. O API Gateway chama um serviço individual, que …

30 architecture  api-design  microservices 

Estou avaliando uma biblioteca cuja API pública se parece atualmente com esta: libengine.h /* Handle, used for all APIs */ typedef size_t enh; /* Create new engine instance; result returned in handle */ int en_open(int mode, enh *handle); /* Start an engine */ int en_start(enh handle); /* Add a new …

27 c  api-design  libraries 

Esta pergunta foi migrada do Stack Overflow porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 8 anos . Preciso reservar nomes de usuário no meu novo site. Estes geralmente se enquadram em três categorias 1) nomes de usuário que ninguém deve ter (por exemplo: administrador, usuário, serviço, …

26 database  design  data  api-design 

Estou pensando em mudar uma API REST monolítica para uma arquitetura de microsserviço e estou ficando um pouco confuso sobre o armazenamento de dados. A meu ver, alguns dos benefícios dos microsserviços seriam: Escalonável horizontalmente - posso executar várias cópias redundantes de um microsserviço para lidar com a carga e …

26 architecture  rest  api-design  microservices 

Ao criar uma API RESTful , devo usar verbos HTTP no mesmo URL (quando possível) ou devo criar um URL específico por ação? Por exemplo: GET /items # Read all items GET /items/:id # Read one item POST /items # Create a new item PUT /items/:id # Update one item …

25 rest  api-design  web-api 

Ao discutir APIs entre sistemas (no nível de negócios), geralmente há dois pontos de vista diferentes em nossa equipe: algumas pessoas preferem uma abordagem abstrata mais - digamos - genérica , outras uma abordagem "concreta" direta. Exemplo: o design de uma API simples de "pesquisa por pessoa". a versão concreta …

25 api  web-services  api-design 

No meu projeto atual, sou responsável pela implementação de um serviço que envolve o consumo de APIs RESTful recém-criadas, documentadas como suportando apenas o JSON. O cliente faz solicitações consistentemente com o cabeçalho de aceitação de 'application / json' e o tipo de conteúdo de 'application / json'. No entanto, …

25 rest  api-design  json  bad-code 

Eu tenho uma plataforma de trilhos que mantenho. Ele tem muitos aplicativos Web diferentes criados sobre ele. No entanto, agora um cliente está solicitando uma API para que ele possa manter os usuários em seu site, mas aproveite algumas das tarefas automatizadas que temos. A plataforma é usada para criar …

25 web-applications  ruby-on-rails  api-design 

Esta pergunta foi migrada da falha do servidor porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 6 anos . Atualmente, estou implementando uma API HTTP, minha primeira vez. Passei muito tempo procurando na página da Wikipedia por códigos de status HTTP, porque estou determinado a implementar os …

24 api-design  http 

Estou projetando uma API REST para um projeto em que os usuários estão sempre em um dos vários "planos" - cada plano define alguns limites de recursos, como o número máximo de usuários que uma conta pode ter ou o número máximo de dados que eles podem carregar. Quando um …

24 rest  api-design  http