Génie logiciel api-design

14

Devez-vous écrire votre back-end en tant qu'API?

J'ai eu une discussion animée aujourd'hui au sujet de notre application MVC. Nous avons un site Web écrit en MVC ( ASP.NET ), et il suit généralement le modèle de faire quelque chose dans la vue -> appuyer sur le contrôleur -> le contrôleur construit un modèle (appelle un gestionnaire …

322 mvc asp.net-mvc api-design

4

Qu'est-ce qu'une couche anti-corruption et comment est-elle utilisée?

J'essaie de comprendre ce que la couche anti-corruption signifie vraiment. Je sais que c'est un moyen de faire la transition / de contourner le code hérité ou de mauvaises API. Ce que je ne comprends pas, c'est comment cela fonctionne et ce qui en fait une séparation nette de la …

151 design-patterns api-design legacy bad-code

7

Comment les recherches s'intègrent-elles dans une interface RESTful?

Lors de la conception d'une interface RESTful, la sémantique des types de demandes est considérée comme essentielle à la conception. GET - Lister une collection ou récupérer un élément PUT - Remplace la collection ou l'élément POST - Créer une collection ou un élément DELETE - Eh bien, erm, delete …

137 design rest api-design http-request

14

La solution doit-elle être aussi générique que possible ou aussi spécifique que possible?

Disons que j'ai une entité qui a l'attribut "type". Il pourrait y avoir plus de 20 types possibles. Maintenant, on me demande d'implémenter quelque chose qui permettrait de changer le type de A-> B, qui est le seul cas d'utilisation. Devrais-je donc implémenter quelque chose qui permet des changements de …

124 programming-practices api-design requirements

5

Dois-je renvoyer un statut HTTP 400 (requête incorrecte) si un paramètre est syntaxiquement correct, mais enfreint une règle de gestion?

Dites que j'ai un point de terminaison REST qui prend un entier en tant que paramètre: /makeWaffles?numberOfWaffles=3 Dans ce cas, je veux que le nombre soit positif car je ne peux pas créer un nombre négatif de gaufres (et demander 0 gaufres est une perte de temps). Je souhaite donc …

56 api-design http

9

Devriez-vous vous protéger contre les valeurs inattendues des API externes?

Disons que vous codez une fonction qui prend l’entrée d’une API externe MyAPI. Cette API externe MyAPIa un contrat qui stipule qu’elle renverra un stringou number. Est - il recommandé de se prémunir contre des choses comme null, undefined, boolean, etc. , même si elle ne fait pas partie de …

51 design api api-design web-services functions

10

Quel devrait être le code de statut http pour l'erreur «Le service n'est pas disponible dans votre région»?

Notre service est présent dans 5 villes. Si quelqu'un essaie d'appeler notre API de service depuis une autre ville, nous voulons lancer cette erreur Service not available in your area. La question est, quel est le code http approprié serait pour cette erreur? 503 Service Indisponible 403: interdit ou autre …

51 api api-design http

14

Conception d'API RESTful. Que dois-je retourner s'il n'y a pas de lignes?

Je suis en train de coder une API pour un réseau social avec le Slim Framework. Ma question est la suivante: quelles sont les meilleures pratiques lorsqu'il n'y a aucune ligne à renvoyer dans la structure json? Disons que cet appel / v1 / get / movies renvoie 2 lignes …

50 programming-practices rest api-design json

6

Nombreuses petites demandes par rapport à quelques grandes demandes (conception d'API)

Je travaille actuellement sur un projet avec une organisation comme suit: Client - Obtient des données du serveur principal via l'API REST. Serveur - Demande des données à différents serveurs via des API tierces API tierces - Services hors de mon contrôle qui fournissent des données au serveur (Reddit, Hackernews, …

49 design rest api-design server

3

Pourquoi la méthode PATCH n'est pas idempotente?

Je me demandais à ce sujet. Supposons que j'ai une userressource avec idet des namechamps. Si je veux mettre à jour un champ, je pourrais simplement faire une requête PATCH à la ressource comme ceci PATCH /users/42 {"name": "john doe"} Et puis l'application mettra à jour le nom d'utilisateur 42. …

48 rest api-design http web-api

6

Dans quelle mesure est-il nécessaire de suivre des pratiques de programmation défensives pour un code qui ne sera jamais rendu public?

J'écris une implémentation Java d'un jeu de cartes, alors j'ai créé un type spécial de Collection que j'appelle une Zone. Toutes les méthodes de modification de la collection Java ne sont pas prises en charge, mais il existe une méthode dans l'API de zone move(Zone, Card), qui déplace une carte …

45 java programming-practices data-structures api-design

3

Quel est le problème avec le DOM?

J'entends toujours des gens (Crockford en particulier) dire que le DOM est une API terrible, mais ne justifie pas vraiment cette déclaration. Outre les incohérences entre les navigateurs, quelles sont les raisons pour lesquelles le DOM est considéré comme si mauvais?

42 javascript api api-design dom

8

Pourquoi java.util.ArrayList permet-il d’ajouter null?

Je me demande pourquoi java.util.ArrayListpermet d'ajouter null. Y a-t-il un cas où je voudrais ajouter nullà un ArrayList? Je pose cette question parce que dans un projet, nous avions un bogue qui ajoutait du code nullà la ArrayListet il était difficile de localiser la bogue. De toute évidence, un a …

41 java api-design collections

1

null vs clé manquante dans la réponse de l'API REST [fermé]

Dites dans mon application, certains utilisateurs nous donnent leur nom de famille, d'autres non. Dans une réponse de l'API REST, quel corps est préféré: Avec une valeur "null": {"firstName": "Bob", "lastName": null} Ou juste une clé manquante: {"firstName": "Bob"}

41 rest api-design json

11

Une API REST doit-elle renvoyer une erreur 500 Internal Server pour indiquer qu'une requête fait référence à un objet inexistant?

Je travaille avec une API REST qui réside sur un serveur qui gère les données pour une multitude de périphériques IoT. Ma tâche consiste à interroger le serveur à l'aide de l'API pour collecter des informations de performances spécifiques concernant ces périphériques. Dans un cas, j'obtiens une liste des périphériques …

39 api-design error-handling http-response

Questions marquées «api-design»