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

17
Detectando IEnumerable "Máquinas de Estado"

Acabei de ler um artigo interessante chamado Ficando muito fofo com retorno de rendimento em c # Isso me fez pensar qual é a melhor maneira de detectar se um IEnumerable é uma coleção enumerável real ou se é uma máquina de estado gerada com a palavra-chave yield. Por exemplo, você pode modificar...

16
Quando usar recursos aninhados em uma API RESTful

Eu tenho dois recursos: usuários e links. Os usuários podem ter vários links associados a eles. Eu projetei minha API RESTful para que você possa acessar os links associados a um usuário no seguinte URI: /users/:id/links No entanto, eu sempre preciso ter um URI apenas para links - às vezes eu...

16
Quando devo usar string_view em uma interface?

Estou usando uma biblioteca interna que foi projetada para imitar uma biblioteca C ++ proposta e, em algum momento nos últimos anos, vejo sua interface alterada de usar std::stringpara string_view. Então, eu mudo obedientemente meu código, de acordo com a nova interface. Infelizmente, o que eu...

15
O que as excelentes APIs têm em comum? [fechadas]

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...

15
API RESTful e i18n: como projetar a resposta?

Estamos projetando uma API RESTful que se destina principalmente a atender às necessidades de um único cliente. Por causa de suas circunstâncias muito particulares, esse cliente precisa fazer o menor número possível de solicitações. A API manipula o i18n por meio de um cabeçalho Accept-Language...

13
Quando devo usar o AtomPub?

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,...

13
Usar composição e herança para DTOs

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...

12
Design da API da biblioteca C ++

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...

12
Manter API vs. usar expressões idiomáticas em uma porta

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...

12
Devo ser permissivo de parâmetros desconhecidos?

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 é...

12
JSON simples ou aninhado para dados hierárquicos?

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,...