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

Estou trabalhando no agrupamento de uma API C ++ que fornece acesso a um armazenamento de dados (Hazelcast) em funções C, para que o armazenamento de dados também possa ser acessado a partir de código somente C. A API Hazelcast C ++ para a estrutura de dados do Mapa é …

9 c++  c  api-design 

Digamos que você tenha algum tipo de estrutura de dados, que persiste em algum tipo de banco de dados. Para simplificar, vamos chamar essa estrutura de dados Person. Agora você está encarregado de criar uma API CRUD, que permite que outros aplicativos criem, leiam, atualizem e excluam Persons. Para simplificar, …

9 design  api  web-services  api-design  crud 

Normalmente, os ouvintes de eventos não devem sobreviver ao objeto que os registrou. Isso significa que os ouvintes de eventos devem ser mantidos por referências fracas por padrão (armazenadas em coleções fracas pelos objetos em que os ouvintes estão registrados)? Existem casos válidos em que o ouvinte deve sobreviver ao …

9 api-design  event 

Suponha que você tenha um grande projeto suportado por uma base de API. O projeto também envia uma API pública que os usuários finais (ish) podem usar. Às vezes, você precisa fazer alterações na base da API que suporta seu projeto. Por exemplo, você precisa adicionar um recurso que precise …

9 versioning  api-design 

Digamos que tenho o seguinte: package me.my.pkg; public interface Something { /* ... couple of methods go here ... */ } e: package me.my; import me.my.pkg.Something; public class SomeClass implements Something { /* ... implementation of Something goes here ... */ /* ... some more method implementations go here too …

9 java  api-design  patterns-and-practices  anti-patterns 

Por favor, acerte uma discussão entre mim e um amigo. No momento, estamos projetando uma API do produto. Nossa entidade de produto se parece com isso { "Id": "", "ProductName": "", "StockQuantity": 0 } As vendas dos produtos são realizadas por terceiros e são obrigadas a nos informar a quantidade …

8 design  design-patterns  rest  api-design  rpc 

Acho que um dos maiores pontos negativos do trabalho com microsserviços é garantir que as APIs estejam bem documentadas e que as APIs não alterem seu comportamento sem afetar os aplicativos downstream. Esse problema se amplifica quando você tem muitos serviços que são interdependentes entre si. Talvez nesse momento você …

8 api-design  documentation  microservices 

Ao projetar um serviço da Web RESTful, a API deve ser projetada para funcionar com o ID de Strings para valores passados ​​entre o servidor? Aqui está um exemplo: digamos que eu tenho um recurso Employee, que possui atributos de status e de gênero. No banco de dados, Status e …

8 rest  api-design  json 

Do comentário de Roy Fielding em seu próprio artigo, descriptografando APIs falsas do REST : Uma API verdadeiramente RESTful se parece com hipertexto. Toda unidade de informação endereçável carrega um endereço, explicitamente (por exemplo, atributos de link e ID) ou implicitamente (por exemplo, derivado da definição de tipo de mídia …

8 rest  api  api-design 

Essa pergunta me incomoda há alguns dias e parece que várias práticas se contradizem. Exemplo Iteração 1 public class FooDao : IFooDao { private IFooConnection fooConnection; private IBarConnection barConnection; public FooDao(IFooConnection fooConnection, IBarConnection barConnection) { this.fooConnection = fooConnection; this.barConnection = barConnection; } public Foo GetFoo(int id) { Foo foo = …

8 c#  unit-testing  api-design  dependency-injection  solid 

No passado, usei a maneira padrão de adicionar @Deprecatedanotações aos métodos de API que serão removidos em uma versão posterior. Agora estou preparando uma versão principal para uma biblioteca, com muitas partes da API removidas e renomeadas. Para facilitar a transição para usuários existentes, talvez seja útil se a nova …

8 java  api-design  libraries  versioning 

Estou vendo que mais e mais novas APIs usam tokens de página para permitir que o usuário se mova entre as páginas de resultados que contêm muitos itens. No entanto, do ponto de vista do designer da API, não estou claro quais são os benefícios de usar um token quando …

8 programming-practices  rest  api-design 

Em nossa API, temos alguns tipos de dados centrais que precisam ser "decorados" (por assim dizer) após a recuperação do banco de dados com valores calculados. O banco de dados é acessado através de um ORM que segue uma dinâmica de Tabela / Entidade fortemente inspirada na camada de banco …

8 database  data-structures  functional-programming  api-design  orm 

Em uma API REST de aplicativo principal que abrange vários domínios relacionados, faz mais sentido dividir recursos em 'áreas' com base no domínio de negócios ao qual eles pertencem ou é melhor manter um único modelo? Por exemplo, existem subdomínios 'Vendas' e 'Inventário'. Os usuários do sistema geralmente se preocupam …

8 architecture  rest  api-design 

Estou criando uma API que utilizará tokens de acesso para que eu possa rastrear o uso entre vários departamentos e para controle de acesso. Meu plano é utilizar os verbos HTTP adequadamente - GETrecuperará informações, POSTadicionará, DELETEexcluirá etc. Minha pergunta é: como devo lidar com tokens de acesso nas chamadas …

8 design  design-patterns  api  api-design