background preloader

Designer une API REST

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 ? » : Rejoignez nous! 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”. KISS – « Keep it simple, stupid » Exemples cURL Exemple Granularité Moyenne Sécurité Exemples ou

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. 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. Tout au long de ces articles, vous avez peut-être remarqué que j'ai un penchant pour les API REST. Notre première ressource Dans notre deuxième article, nous avons parlé un peu de ressources. Décider quelles ressources seront disponibles. Rechercher des données

Introduction | Axios Docs Client HTTP basé sur les promesses pour navigateur et node.js Axios est un client HTTP basé sur les promesses compatible avec node.js et les navigateurs. Il est isomorphique (c’est à dire qu’il peut opérer dans le navigateur et dans node.js avec le même code). Côté serveur, il utilise le module natif http de node.js, et côté client (navigateur) il utilise les XMLHttpRequests. Faire des XMLHttpRequests depuis le navigateurFaire des requêtes http depuis node.jsSupporter l’API Promise (promesses)Intercepter des requêtes et/ou des réponsesTransformer les données de requêtes et/ou de réponsesAnnuler des requêtesTransformer automatiquement les données JSONProtéger contre les XSRF côté client Avec npm : $ npm install axios Avec bower : $ bower install axios Avec yarn : $ yarn add axios Avec le CDN jsDelivr : Avec le CDN unpkg :

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

axios Platinum sponsors Alloy is the integration development platform that makes it simple and fast for SaaS companies to launch critical user-facing integrations. Sign up free • Documentation Gold sponsors Promise based HTTP client for the browser and node.js Website • Documentation Table of Contents Features Make XMLHttpRequests from the browserMake http requests from node.jsSupports the Promise APIIntercept request and responseTransform request and response dataCancel requestsAutomatic transforms for JSON data🆕 Automatic data object serialization to multipart/form-data and x-www-form-urlencoded body encodingsClient side support for protecting against XSRF Browser Support Installing Package manager Using npm: Using bower: Using yarn: Using pnpm: Once the package is installed, you can import the library using import or require approach: import axios, {isCancel, AxiosError} from 'axios'; You can also use the default export, since the named export is just a re-export from the Axios factory: Using unpkg CDN:

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 ? Si c'est le cas, ce qui suit devrait vous passionner. 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 ? Récapitulation

API REST – les outils et les techniques pour le développeur Web | Atomrace :: nouvelles écolos et technos La révolution App En septembre 2014, le App Store de Apple a franchit le cap du 1,2 million d’applications offertes pour un total de 75 milliards de téléchargements. [1] Augmentation du nombre d’Apps sur le App Store de 2008 à 2012. Durant les 5 dernières années, une révolution s’est opérée dans la façon de développer des applications Internet. Développement Web de 2002 à 2011 – R.I.P Le vieux modèle de développement d’application web dynamique où le serveur fait la requête à la base de données et encapsule ces données dans du HTML, pour ensuite retourner cette longue chaîne de caractères au client, semble dorénavant désuet. Pourquoi utiliser un API ? Les API livrent des fonctionnalités aux sites Web;Les API sont derrière les applications Web;Les API donnent la puissance aux applications mobiles;Les API permettent de connecter des appareils physiques. Nouveau modèle : API RESTful avec JSON Quelques définitions JSON : JavaScript Object Notation

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

Consommer une API publique en cross-domain dans un navigateur avec JS et JSONP Ces dernières années, le secteur du web a évolué très rapidement. Le nombre de terminaux mobiles a explosé, et les navigateurs ont vu leurs capacités augmenter radicalement. De fait, le modèle classique du serveur ne fournissant que des pages html à des browsers d’ordinateurs de bureau a décliné. Je cherche un job dans lequel je me sens bien maintenant ! À sa place s’est développé un écosystème de services, exposant leurs données dans plusieurs formats pour une foule de clients différents. L’utilisation d’un proxy Il s’agit de la méthode la plus évidente: employer un proxy sur le domaine hébergeant la page, par lequel transiteront les requêtes destinées à d’autres domaines, effectuées normalement via AJAX. CORS est l’acronyme de Cross Origin Resource Sharing. Je cherche un job dans lequel je me sens bien maintenant ! JSONP est l’acronyme de JSON with Padding. Une implémentation simple de code client JSONP Le code de l’exemple complet est disponible sur github >> Ceci dit, place au code.

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.

Swagger UI Implementation Notes Simple scoring of a task (Habit, Daily, To-Do, or Reward). This is most-likely the only API route you'll be using as a 3rd-party developer. The most common operation is for the user to gain or lose points based on some action (browsing Reddit, running a mile, 1 Pomodor, etc). Call this route, if the task you're trying to score doesn't exist, it will be created for you. Request URL Response Body Response Code Response Headers jQuery / YOUTUBE API V3 - Récupérer les données d'une vidéo Précédemment nous avons vu comment valider l’existence d’une vidéo Youtube avec jQuery. Depuis la sortie de la version 3 de l’API Youtube par Google et la dépréciation de la version 2, le code du précédent article est maintenant désuet! Et oui, ça va vite le web!!! Prérequis Avant de commencer à coder, une petite nouveauté est apparue. Vous rendre et vous connecter ou créer un compte si ce n’est pas déjà fait sur la console de google.Créez un nouveau Projet, que vous nommerez comme bon vous semble.Dans le menu de gauche cliquez sur “API et Authentification” puis sur “API”.Une liste de toutes les API mises à votre disposition par Google est alors disponible.Cliquez sur “Youtube Data API” puis sur le bouton bleu “Activer l’API”. Votre API est maintenant active, ne vous reste plus qu’à créer une clef utilisateur : Il me semble maintenant que vous êtes prêts pour jouer avec l’API Youtube V3. Code Source jQuery Récupérer les données d'une vidéo avec l'API V3 de Youtube

Tutoriel vidéo PHP : API Instagram | Grafikart Je vous propose de découvrir aujourd'hui comment utiliser l'API d'instagram. Comme beaucoup, Instagram ne permet pas de taper son API librement, il faudra passer par un Client Création d'un client La création d'un client pour instagram est très simple et il vous faudra seulement posséder un compte Instagram pour accéder à l'interface de création. La seule information réellement importante ici est OAuth redirect_uri. Ce paramètre indique vers quelle URL sera redirigé l'utilisateur après avoir accepté ou refusé l'application. Une fois l'application créée vous obtiendrez 2 informations important Client_id qui vous permettra de faire des appels à certains éléments de l'APIClient_secret que vous ne devez pas diffuser, et qui vous permettra de demander un token d'accès Sans authentification Pour appeller cette page en PHP nous allons utiliser CURL qui permet d'avoir plus de contrôle qu'un file_get_content() Avec Authentification Conclusion

Deliveroo lance une API pour permettre aux restaurateurs d’économiser du temps Deliveroo lance une API gratuite et ouverte destinée à être intégrée sur les terminaux de points de vente (TPV) pour rationaliser le processus de commande et simplifier la préparation de la commande pour les employés des restaurants. Cette nouvelle technologie va permettre aux restaurants de gagner d’une part un temps précieux, et d’autre part, d’économiser des millions d’euros en augmentant la productivité de leurs équipes. L’intégration de cette API au terminal de point de vente des restaurants représente un avantage précieux pour ceux qui proposent un service de la livraison à domicile, et est une demande récurrente des restaurateurs. Deliveroo permet l’intégration au terminal de point de vente en créant une nouvelle API, gratuite, ouverte et disponible sur le nouveau portail développeur Deliveroo, pour que les terminaux de point de vente des entreprises et restaurants aient accès au système de commande de Deliveroo. Mike Hudack, Chief Technology Officer chez Deliveroo:

Related: