Questions marquées «api-design»

La conception de l'API (Application Programming Interface) décrit les meilleures pratiques pour la création de bibliothèques destinées à un usage général ou public.

6
Qu'est-ce que les excellentes API ont en commun? [fermé]
Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement les réponses. Fermé il y a 6 ans . Verrouillé . Cette question et ses réponses sont verrouillées car la question est hors sujet mais a une signification historique. Il n'accepte pas actuellement de nouvelles réponses ou …
15 api-design 
7
Comment concevoir l'authentification des utilisateurs à partir des applications clientes?
J'ai développé une application qui supportera de nombreux utilisateurs. Le problème est que je ne peux pas comprendre comment authentifier le client / utilisateur. Je crée une application comme http://quickblox.com/ où je donnerai des informations d'identification à mes utilisateurs et ils les utiliseront pour créer N applications dans lesquelles ils …
3
Les ID de backend doivent-ils être publics ou non sur une API REST?
Basé sur ce que dit ce type: http://toddfredrich.com/ids-in-rest-api.html Supposons qu'il ait raison d'utiliser UUID pour identifier les ressources de l'API. Ensuite, je rencontre des problèmes pour essayer de l'implémenter de cette façon, c'est: class FooEntity { final String id = null; //auto-generated by my backend (mongodb), not shared final UUID …
4
Utiliser la composition et l'héritage pour les DTO
Nous avons une API Web ASP.NET qui fournit une API REST pour notre application de page unique. Nous utilisons des DTO / POCO pour transmettre des données via cette API. Le problème est maintenant que ces DTO grossissent avec le temps, alors maintenant nous voulons refactoriser les DTO. Je recherche …
13 rest  api-design  web-api  dto  poco 
1
Quand dois-je utiliser AtomPub?
J'ai mené des recherches sur la conception de services Web RESTful et j'ai atteint ce que je pense être un point de décision clé, alors j'ai pensé que je l'offrirais à la communauté pour obtenir des conseils. Conformément aux principes d'une architecture RESTful, je souhaite présenter une API détectable, donc …
3
JSON plat ou imbriqué pour les données hiérarchiques?
J'ai déjà fait des allers-retours ~ 5 fois. Ce point de terminaison REST /api/tags/sera à usage interne (pas de clients tiers), je suis le seul à travailler avec. Je décide entre ces deux représentations: Plat { "types":[ { "id":1, "text":"Utility" }, { "id":7, "text":"Lease Terms" }, ], "tags":[ { "id":8, …
12 rest  api-design  json 
2
Dois-je tolérer des paramètres inconnus?
Je conçois une API RESTful et confronté au problème de titre, reformulé pour plus de clarté: Dois-je échouer rapidement si un client envoie un paramètre non reconnu? Par exemple, http://example.com/api/foo?bar=true&paula=bean Dans ce qui précède, barest un paramètre valide mais paulan'est pas spécifié par l'API. Devrais-je Avertir le client de l'erreur …
12 rest  api-design 
1
Maintenir l'API ou utiliser des idiomes dans un port
Je travaille sur un port de Python à Rust et j'ai rencontré du code qui ne peut pas être exprimé aussi naturellement dans Rust que dans Python. Un cas de cela utilise des paramètres par défaut: class Foo: def __init__(self, a="Hello"): self._a = a Dans Rust, vous pouvez implémenter cela …
2
Conception d'API de bibliothèque C ++
Je suis à la recherche d'une bonne ressource pour en savoir plus sur la bonne conception d'API pour les bibliothèques C ++, la recherche d'objets partagés / DLL, etc. Il existe de nombreuses ressources sur l'écriture de belles API, de belles classes, de modèles et ainsi de suite au niveau …
2
Comment concevoir des points de terminaison API pour publier un objet enfant et pour obtenir tous les enfants de tous les parents?
Par exemple, j'ai des entités: Client, Rapport. Le client peut avoir de nombreux rapports et je pense que le point de terminaison d'une seule gestion de rapport devrait être imbriqué comme ceci: /clients/{client_id}/reports/{report_id} Comme pour tous les rapports d'un client, le point final est attendu: /clients/{client_id}/reports Mais à quoi devrait …
12 rest  api  api-design 
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.