Concevoir une API On passe aux choses sérieuses… Dans cet article, nous allons parler des composants d'une API en en créant une nous-mêmes. Par l'ami Brian Cooksey, le roi de la pizza pepperoni. Par Brian Cooksey C'est déjà le cinquième article de cette série (1) et nous arrivons maintenant à un tournant dans notre aventure au royaume des API. Nous avons couvert les fondamentaux, et nous sommes prêts à voir comment les concepts précédents peuvent être combinés pour créer une API. Dans cet article, nous allons parler des composants d'une API en en créant une nous-mêmes. Organiser les données National Geographic a estimé qu'en 2011 les américains ont fait 80 milliards de photos. Il en va de même avec les entreprises lorsqu'elles créent leurs API. Choisir un style d'architecture Dans les discussions à propos d'API, vous entendez parler de “soap” et de “rest” et vous vous demandez peut-être si les développeurs sont en train de travailler ou de parler de leurs prochaines vacances. Notre première ressource
Designer une API REST La période de fêtes approchant à grands pas, nous vous proposons une “Quick Reference Card” sur le design des API dont l’objectif est de synthétiser les bonnes pratiques de conception et de design d’API REST. Télécharger l’API Design – Quick Reference Card « Vous aimez les API, le Web ? Si vous avez plus de temps, le présent article reprend – point par point – les éléments de la « carte de référence », en étayant et justifiant les propositions. Bonne lecture! Lorsque l’on souhaite concevoir une API, on est rapidement confronté à la problématique du « design d’API ». La mise en oeuvre d’une API à l’état de l’Art nécessite de prendre en compte: non seulement les principes substantiels des API RESTful issus de la littérature de référence (Roy Fielding, Leonard Richardson, Martin Fowler, spécifications HTTP…)mais également les bonnes pratiques utilisées par les API des “Géants du Web”. DISCLAIMER : Cet article constitue un recueil de bonnes pratiques, qui peuvent bien entendu être discutées. ou
API Blueprint Tutorial | API Blueprint API Blueprint Tutorial Welcome to an API Blueprint Tutorial! This tutorial will take you through the basics of the API Blueprint language. We’re going to build an API blueprint step by step for a service called Polls – a simple API allowing consumers to view polls and vote in them. You can take a look at the full version of the blueprint used in this tutorial for reference. Note: Additional API Blueprint Resources API Blueprint The first step for creating a blueprint is to specify the API Name and metadata. FORMAT: 1A # Polls Polls is a simple API allowing consumers to view polls and vote in them. The blueprint starts with a metadata section. API Name & Description The first heading in the blueprint serves as the name of your API, which in this case is "Polls". Following the heading is a description of the API. Resource Groups Now it's time to start documenting the API resources. # Group Questions Resources related to questions in the API. Resource ## Question Collection [/questions] Actions
API, une introduction Vous êtes-vous déjà demandé comment Facebook affiche automatiquement vos photos Instagram ? Brian Cooksey commence ici une série d'articles passionnants sur les API, dans un langage clair, imagé, sans jargon inutile. Par Brian Cooksey Vous êtes-vous déjà demandé comment Facebook affiche automatiquement vos photos Instagram ? ou comment Evernote synchronise vos notes entre votre ordinateur et votre smartphone ? Dans cette série d'articles (1), nous allons passer en revue tout ce qui est nécessaire pour faire communiquer entre eux deux systèmes. À qui s'adressent ces articles ? Introduction Les API (application programming interface, en français interfaces de programmation) forment une part importante du web. Bien connaître le fonctionnement des API est de plus en plus important lorsqu'on travaille dans le développement web. Un cadre de référence Rien de magique ni de spectaculaire là-dedans, donc. Qu'est-ce qu'une API ? Les sites web sont conçus pour s'appuyer sur les facultés humaines.
Compte-rendu du petit-déjeuner : dessine-moi une API… et dis-moi comment la manager ! Intervenant : Christian Fauré, Manager chez OCTO Technology Agenda : Distinguer les démarches OpenData et OpenAPILa conception des APIs HypermediaPanorama des solutions d’API Management Distinguer les démarches OpenAPI et OpenData Les Démarches OpenData : Elles consistent à publier des jeux de données ;Pour que ces corpus de données publiées puissent être facilement réutilisés, il faut que les données soient les plus auto-descriptives (que leur sémantique soit non ambiguë) ; Les formats doivent être facilement manipulables par des développeurs tiers.Il s’agit de publier un catalogue de données Les démarches Open API : Elles consistent à publier des interfaces pour accéder aux données.Les requêtes à l’API doivent être les plus simples possibles si on veut en favoriser l’usageIl s’agit de publier un catalogue de requête Les démarches OpenAPI et OpenData sont toutes deux des démarches de publication des ressources digitales de l’entreprise, mais elles différent sur les points suivants : Conclusion
API Design Basics | API Academy In the API Strategy section of this site, as well as providing a basic explanation of application programming interfaces, we explore the business drivers that lead many organizations to create APIs and we explain how these interfaces can be divided into two broad categories, based on kind of developers they target – private APIs and open APIs. If you have taken the lessons in that section, you know that initial API design decisions should be based around the business drivers behind your API program. Additionally, you will understand how your API design process should – to a large extent – be guided by the nature of the developer audience you are targeting. We will further explore the impact a developer audience will have on API design patterns in the next lesson. It is also important to remember that the goals an organization sets for its API program must be chosen within the framework of the resources available to the organization and that this should guide its API design decisions.