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

O MVC é bem direto. Há um modelo, um controlador e uma vista. Quando criamos um site, tudo se reúne quando o ' cliente envia a solicitação de palavra-chave REST ao servidor -> o servidor corresponde à URL solicitada à ação do controlador -> que então chama o (s) modelo …

12 design-patterns  mvc  rest  api  api-design 

Em C #, se eu quiser dividir um stringpor outro string, tenho que fazer algo assim: testString.Split(new string[] { "anotherString" }, StringSplitOptions.None); Na String.Splitdocumentação sobrecarregada do MSDN, podemos ver a implementação e por que essa ligação deve ser feita. Vindo do Python , é difícil para mim entender corretamente por …

11 c#  performance  api-design 

Estou tentando converter um conjunto de serviços baseados em SOAP em uma API RESTful. Comecei identificando recursos analisando os nomes das operações e obtive o recurso Subscription. Quando preciso atualizar o estado da assinatura, não posso simplesmente enviar uma POSTsolicitação ao servidor, porque não tenho acesso direto aos recursos, mas …

11 rest  web-services  api-design  web-api 

Eu gostaria de criar um sistema que lida com mensagens de alerta de vários programas e possa processar esses alertas para consumidores de baixa velocidade por email. Tudo isso estaria contido em uma rede interna. Eu acho que quero que a arquitetura básica fique assim: A principal preocupação que tenho …

10 design  design-patterns  architecture  api  api-design 

Um dos recursos propostos para o "Project Coin" do Java 7 foi o "operador Elvis". Um relatório de uma apresentação do JavaOne de 2009 no Project Coin descreveu-o da seguinte forma: Um dos "pequenos recursos" abordados nesta apresentação é o chamado "operador Elvis", uma versão mais concisa do operador ternário. …

10 java  api-design 

Criamos uma biblioteca comercial e exemplos de código que estão sendo usados ​​por desenvolvedores externos. Temos (fechado, disponível para usuários registrados) documentação que explica extensivamente como usar a biblioteca. Muitos dos desenvolvedores são usuários iniciantes, então muitos erros rudimentares são encontrados. É apropriado incluir links para a documentação no log …

10 documentation  api-design  error-handling  error-messages 

Eu sou novo em Java e estava lendo sua documentação sobre exceções. e, especialmente, a página Exceções não verificadas - a controvérsia . A linha inferior diz: Se for razoável esperar que um cliente se recupere de uma exceção, torne-a uma exceção verificada. Se um cliente não puder fazer nada …

10 java  api-design  exceptions 

Dado que as alterações na assinatura da API / método público devem ser mínimas para evitar a quebra dos códigos dos clientes que usam esses métodos, fiquei pensando se a Lei de Demeter é menos aplicável a eles. Um exemplo simples: class Account() { double balance; public void debit(Transaction t) …

10 design  api-design 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 4 anos . Quais são algumas falhas que o deixam louco nas …

10 c  api-design  pitfalls 

Eu tenho o seguinte ponto de extremidade: a/{id}/b e deseja criar uma solicitação de benvio POSTpara ele. Se acom dado {id}não for encontrado, devo responder com 404 NOT_FOUNDou talvez com 409 CONFLICT? É simples a/{id}, o truque é que aqui é usado um sub-recurso.

10 rest  api  api-design  http-request 

Eu tenho que criar um "widget", um script que os parceiros incorporarão em seus sites para exibir alguma interface do usuário e fazer chamadas para nossa API. Basicamente, ele exibirá nossos dados nesses sites com base em alguns códigos que eles fornecem em nossas chamadas de API. O que gostaríamos …

10 security  api-design  web-api 

Ao analisar a entrada do usuário, geralmente é recomendável não lançar e capturar exceções, mas usar métodos de validação. No .NET BCL, essa seria a diferença entre, por exemplo, int.Parse(lança uma exceção em dados inválidos) e int.TryParse(retorna falseem dados inválidos). Estou projetando meu próprio Foo.TryParse(string s, out Foo result) método …

9 c#  .net  api-design 

Como isso: Campaign: type: object properties: id: type: string description: "A GUID identifier" referenceId: type: string description: "A consumers identifier they have used to map their own systems logic to this object." name: type: string description: "'Great Campaign 2017' as an example" Estou preocupado com o referenceId . O domínio …

9 rest  api  domain-driven-design  api-design  single-responsibility 

Adote um ponto de extremidade da API HTTP que cospe o seguinte modelo de resposta: { "type": "Dog", "name": "Jessi", ... } O typecampo foi descrito na documentação como sendo um dos Dog, Catou Fish. A adição de uma nova opção, por exemplo Rat, seria considerada uma alteração de API …

9 rest  api  api-design  json 

Meu entendimento do REST que permite modelar operações de serviço como representação de estado e transição de um estado para outro usando HTTP. Sempre entendi os recursos como representações do estado do lado do serviço até recentemente, quando li este artigo de Jimmy Bogard, que sei ser um desenvolvedor / …

9 rest  api  api-design