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

Fechado . Esta questão precisa ser mais focada . No momento, não está aceitando respostas. Fechado há 6 anos . Bloqueado . Esta pergunta e suas respostas estão bloqueadas porque a questão está fora do tópico, mas tem um significado histórico. No momento, não está aceitando novas respostas ou interações. …

15 api-design 

Estou desenvolvendo um aplicativo que suporta muitos usuários. O problema é que não consigo descobrir como autenticar o cliente / usuário. Estou criando um aplicativo como http://quickblox.com/, onde darei credenciais aos meus usuários e eles os usarão para criar N aplicativos nos quais não poderão colocar seu nome de usuário …

14 design-patterns  architecture  api-design  authentication  enterprise-architecture 

Estou projetando uma API de serviço REST e fiquei preso na maneira correta de aninhar recursos. Recursos: parceiros, tickets, configurações Conexões entre recursos: parceiro tem muitos tickets, o parceiro definiu configurações, Lógica de negócios: você pode listar todos os parceiros como usuário anônimo, você pode adicionar um novo ticket ao …

14 api  rest  api-design 

Sue está projetando uma biblioteca JavaScript Magician.js,. Seu pino de linch é uma função que retira Rabbito argumento passado. Ela sabe que seus usuários podem querer tirar um coelho de um String, um Number, um Function, talvez até um HTMLElement. Com isso em mente, ela poderia criar sua API da …

14 javascript  api  api-design 

Temos uma API Web do ASP.NET que fornece uma API REST para nosso aplicativo de página única. Usamos DTOs / POCOs para transmitir dados por essa API. O problema agora é que esses DTOs estão aumentando ao longo do tempo, então agora queremos refatorar os DTOs. Estou procurando "práticas recomendadas" …

13 rest  api-design  web-api  dto  poco 

Tenho conduzido algumas pesquisas sobre o design de serviços da Web RESTful e cheguei ao que considero um ponto de decisão fundamental, então pensei em oferecer à comunidade para obter alguns conselhos. De acordo com os princípios de uma arquitetura RESTful, quero apresentar uma API detectável, por isso darei suporte …

13 web-services  rest  api-design 

Com base no que esse cara diz: http://toddfredrich.com/ids-in-rest-api.html Vamos supor que ele esteja certo ao usar o UUID para identificar os recursos da API. Então eu me deparo com problemas tentando implementá-lo dessa maneira, isto é: class FooEntity { final String id = null; //auto-generated by my backend (mongodb), not …

13 database  api-design  mongodb 

Estou lendo o livro Princípios, práticas e padrões de injeção de dependência e li sobre o conceito de abstração com vazamento, que é bem descrito no livro. Hoje em dia estou refatorando uma base de código C # usando injeção de dependência, para que chamadas assíncronas sejam usadas em vez …

13 c#  object-oriented  api-design  interfaces  dependency-injection 

Já mudei de um lado para o outro ~ 5 vezes. Esse ponto de extremidade REST /api/tags/será para uso interno (sem clientes de terceiros), eu sou o único que trabalha com ele. Estou decidindo entre essas duas representações: Plano { "types":[ { "id":1, "text":"Utility" }, { "id":7, "text":"Lease Terms" }, …

12 rest  api-design  json 

Estou projetando uma API RESTful e enfrentando o problema do título, atualizado para maior clareza: Devo falhar rapidamente se um cliente enviar um parâmetro não reconhecido? Por exemplo, http://example.com/api/foo?bar=true&paula=bean Acima, baré um parâmetro válido, mas paulanão é especificado pela API. Eu devo Avise o cliente do erro Falhar rápido Ignore …

12 rest  api-design 

Estou trabalhando em uma porta do Python para o Rust e encontrei um código que não pode ser expresso tão naturalmente no Rust quanto no Python. Um caso disso é usar parâmetros padrão: class Foo: def __init__(self, a="Hello"): self._a = a No Rust, você pode implementar isso usando um construtor: …

12 api-design  porting 

Estou no processo de projetar uma API HTTP, espero que seja o mais RESTful possível. Existem algumas ações cuja funcionalidade se espalha por alguns recursos e, às vezes, precisa ser desfeita. Pensei comigo mesmo: isso parece um padrão de comando, mas como posso modelá-lo em um recurso? Vou apresentar um …

12 design-patterns  api  rest  api-design  http 

Estou procurando um bom recurso para aprender sobre o bom design de API para bibliotecas C ++, examinar objetos / dlls compartilhados etc. Há muitos recursos para escrever boas APIs, boas classes, modelos etc. no nível da fonte, mas quase nada sobre reunindo coisas em bibliotecas e executáveis ​​compartilhados. Livros …

12 c++  libraries  api-design  dll 

Por exemplo, tenho entidades: Cliente, Relatório. O cliente pode ter muitos relatórios e acho que o ponto final de um único gerenciamento de relatórios deve ser aninhado assim: /clients/{client_id}/reports/{report_id} Quanto a todos os relatórios de um cliente, o enpoint é esperado: /clients/{client_id}/reports Mas como deve ser um ponto de extremidade …

12 rest  api  api-design 

Vejo muitas perguntas girando em torno do acesso a chaves JSON que usam hífens (kebab-case), mas agora me pergunto se devo me ater ao camelCase ou snake_case nas minhas chaves. Eu sei que os hífens também podem criar mapeamentos complicados quando portados entre idiomas. Eu já vi algumas bibliotecas desserializadas …

12 javascript  api  api-design  json  web-api