Passer aux informations sur le produit
Conception d'API Web inspirée par les objets du quotidien
Conception d'API Web inspirée par les objets du quotidien
Description
Introduction au livre
Les API Web vous permettent de tirer parti des fonctionnalités offertes par les services existants lors de la création de nouveaux services ou applications.
On peut le comparer à des Lego qui peuvent être facilement intégrés à un projet créé par un développeur, même sans connaître le code source détaillé du service existant.
Comment créer une API qui permette à d'autres développeurs et à d'autres applications d'utiliser facilement mon service ?

Ayant travaillé sur la conception et le développement de diverses API web pendant plus de 10 ans, Arnaud Loret a organisé le savoir-faire, jusque-là réservé aux concepteurs d'API web, en concepts facilement compréhensibles.

« La conception d'API Web à travers les objets du quotidien » présente des méthodes de conception d'API utilisant des objets du quotidien que nous tenons pour acquis et que nous n'explorons pas en profondeur.
Ce livre illustre comment transformer des objets apparemment incompréhensibles — comme une télécommande aux boutons enchevêtrés ou un réveil affichant un compte à rebours — en quelque chose de familier, en établissant un lien avec la conception d'API web. Des principes fondamentaux de la conception d'API à la création d'API web conviviales et à leur gestion une fois opérationnelles, ce livre aborde tous les concepts nécessaires à la conception d'une API de qualité.
Mettons la main sur les connaissances essentielles pour ceux qui créent des services web modernes.
  • Vous pouvez consulter un aperçu du contenu du livre.
    Aperçu

indice
Partie 1. Principes fondamentaux de la conception d'API

1. Qu'est-ce que la conception d'API ?
1.1 Qu'est-ce qu'une API ?
1.1.1 Interface Web du logiciel
1.1.2 Transformer un logiciel en Lego
1.2 Pourquoi la conception des API est importante
1.2.1 Les API publiques et privées sont également utilisées par d'autres développeurs.
L'API 1.2.2 masque l'implémentation
1.2.3 Une mauvaise conception d'API conduit à des résultats catastrophiques
1.3 Éléments requis pour la conception d'une API
1.3.1 Comprendre les principes de conception au-delà des interfaces de programmation
1.3.2 Tous les aspects de la conception des API

2.
Concevoir des API pour les utilisateurs
2.1 La bonne perspective pour concevoir des interfaces utilisateur au quotidien
2.1.1 Se concentrer sur la façon dont les choses fonctionnent rend l'interface complexe.
2.1.2 L’interface devient plus simple lorsque l’utilisateur se concentre sur ce qu’il ou elle peut faire.
2.2 Méthodes de conception d'interfaces logicielles
2.2.1 Utilisation de l'API comme panneau de contrôle pour votre logiciel
2.2.2 Création d'une API simple axée sur le point de vue du consommateur
2.3 Processus d'identification des objectifs de l'API
2.3.1 Que faire et comment le faire
2.3.2 Qu'est-ce qui est une entrée et qu'est-ce qui est une sortie ?
2.3.3 Existe-t-il des objectifs manquants ?
2.3.4 Avez-vous trouvé tous les utilisateurs ?
2.3.5 Canevas d'objectif API
2.4 Perspectives des fournisseurs à éviter dans la conception d'API
2.4.1 Impact des données
2.4.2 Impact du code et de la logique métier
2.4.3 Impact sur l'architecture logicielle
2.4.4 Impact de l'organisation humaine
2.4.5 Trouver le point de vue du fournisseur dans le canevas d'objectifs de l'API

3.
Conception d'une interface de programmation
3.1 Introduction à l'API REST
3.1.1 Analyse des appels d'API REST
3.1.2 Notions de base du protocole HTTP
3.1.3 Principes de base des API REST
3.2 Processus de transformation des objectifs d'API en API REST
3.2.1 Identification des ressources et des relations entre les ressources à l'aide du canevas d'objectifs de l'API
3.2.2 Identification des actions, de leurs paramètres et de leurs valeurs de retour à l'aide de l'API Goal Canvas
3.2.3 Représentation des ressources, y compris le chemin
3.2.4 Expression des actions avec HTTP
3.2.5 Aide-mémoire sur les API REST et HTTP
3.3 Conception des données API
3.3.1 Conception préliminaire
3.3.2 Conception de la réponse dans le concept
3.3.3 Conception des paramètres : concept et réponse
3.3.4 Vérification des paramètres dans les sources de données
3.3.5 Conception d'autres paramètres
3.4 Comment maintenir l'équilibre face aux défis de conception
3.4.1 Exemple de compromission REST
3.4.2 Concilier la facilité d'utilisation et la conformité aux règles
3.5 Pourquoi REST est important lors de la conception d'API
3.5.1 Introduction au style architectural REST
3.5.2 L'impact des contraintes REST sur la conception des API

4. Conception d'API à l'aide du format de spécification d'API
4.1 Quel est le format de spécification de l'API ?
4.1.1 Introduction à OAS (spécification OpenAPI)
4.1.2 Pourquoi utiliser le format de spécification API ?
4.1.3 Quand utiliser le format de spécification d'API
4.2 Description des ressources et actions de l'API via OAS
4.2.1 Création d'un document OAS
4.2.2 Description de la ressource
4.2.3 Description du comportement des ressources
4.3 Expression des données d'API avec OpenAPI et le schéma JSON
4.3.1 Description des paramètres de requête
4.3.2 Description des données via un schéma JSON
4.3.3 Description de la réponse
4.3.4 Description des paramètres corporels
4.4 Description efficace des API dans OAS
4.4.1 Réutilisation des composants
4.4.2 Description des paramètres de chemin

Partie 2 : Concevoir une API conviviale

5.
Concevoir des API intuitives
5.1 Expression intuitive
5.1.1 Choisir un nom clair
5.1.2 Détermination des types et formats de données faciles à utiliser
5.1.3 Sélection des données prêtes à l'emploi
5.2 Interaction intuitive
5.2.1 Demande d'entrée intuitive
5.2.2 Identification de tous les retours d'erreur possibles
5.2.3 Retour d'informations utiles sur les erreurs
5.2.4 Retour d'information détaillé sur les erreurs
5.2.5 Retourner des commentaires utiles sur la réussite
5.3 Flux intuitif
5.3.1 Créer une chaîne d'objectifs intuitive
5.3.2 Prévention des erreurs
5.3.3 Intégration des objectifs
5.3.4 Conception de flux sans état

6.
Concevoir des API prévisibles
6.1 Maintenir la cohérence
6.1.1 Conception de données cohérentes
6.1.2 Élaboration d'objectifs cohérents
6.1.3 Quatre niveaux de cohérence
6.1.4 Suivre l'exemple des autres : adhérer aux pratiques et normes courantes
6.1.5 La cohérence est difficile à maintenir et doit être appliquée avec sagesse.
6.2 Faciliter l'adaptation
6.2.1 Fournir ou répondre dans d'autres formats
6.2.2 Internationalisation et localisation
6.2.3 Application des filtres, des pages et des tris
6.3 Activation de la navigation
6.3.1 Fourniture de métadonnées
6.3.2 Création d'une API hypermédia
6.3.3 Tirer parti du protocole HTTP

7.
Concevoir des API concises et systématiques
7.1 Structuration de l'API
7.1.1 Structuration des données
7.1.2 Structuration du retour d'information
7.1.3 Structuration des objectifs
7.2 Dimensionnement de l'API
7.2.1 Sélection de la segmentation des données
7.2.2 Sélection d'une segmentation par objectif
7.2.3 Sélection de la segmentation API

Partie 3 : Conception d’API contextuelles

8.
Conception d'API sécurisées
8.1 Aperçu de la sécurité des API
8.1.1 Enregistrement d'un consommateur
8.1.2 Obtention des identifiants pour l'utilisation de l'API
8.1.3 Appel de l'API
8.1.4 Conception des API du point de vue de la sécurité
8.2 Activation du contrôle d'accès via la segmentation des API
8.2.1 Définition de périmètres flexibles et précis
8.2.2 Définition d'une portée simple mais plus large
8.2.3 Choix d'une stratégie de périmètre
8.2.4 Définition des portées dans le format de spécification d'API
8.3 Conception du contrôle d'accès
8.3.1 Comprendre les données requises pour le contrôle d'accès
8.3.2 Ajustements de conception au besoin
8.4 Manipulation des éléments sensibles
8.4.1 Gestion des données sensibles
8.4.2 Manipulation des objets sensibles
8.4.3 Conception d'un retour d'information sécurisé sur les erreurs
8.4.4 Identification des problèmes d'architecture et de protocole

9. Développement de la conception de l'API
9.1 Conception de l'évolution de l'API
9.1.1 Éviter les modifications perturbatrices des données de sortie
9.1.2 Éviter les modifications perturbatrices des données et paramètres d'entrée
9.1.3 Éviter les changements perturbateurs dans les retours d'information sur les succès et les erreurs
9.1.4 Éviter les ruptures dans les changements d'objectifs et de flux
9.1.5 Éviter les vulnérabilités de sécurité lors de changements importants
9.1.6 Attention aux contrats d'interface invisibles
9.1.7 Ce ne sont pas toujours les changements qui entraînent une rupture de compatibilité qui posent problème.
9.2 Définition de la version de l'API
9.2.1 Comparaison du versionnage des API et du versionnage des implémentations
9.2.2 Choix d'une représentation de version d'API du point de vue du consommateur
9.2.3 Détermination de la segmentation du versionnage des API
9.2.4 Impacts du versionnage des API au-delà de la conception
9.3 Tenez compte de l'extensibilité lors de la conception des API
9.3.1 Conception de données évolutives
9.3.2 Conception d'interactions évolutives
9.3.3 Conception de flux évolutifs
9.3.4 Conception d'API extensibles

10.
Conception d'API efficaces pour le réseau
10.1 Aperçu des considérations relatives à la communication réseau
10.1.1 Mise en scène
10.1.2 Analyse du problème
10.2 Garantir l'efficacité des communications réseau au niveau du protocole
10.2.1 Activation de la compression et des connexions persistantes
10.2.2 Activation de la mise en cache et des requêtes conditionnelles
10.2.3 Choix d'une politique de cache
10.3 Garantir l'efficacité des communications réseau au niveau de la conception
10.3.1 Activation du filtrage
10.3.2 Sélection des données associées pour la représentation sous forme de liste
10.3.3 Création d'agrégats de données (Agrégation)
10.3.4 Suggérer d'autres expressions
10.3.5 Activation des extensions
10.3.6 Activation des requêtes
10.3.7 Fournir des données et des objectifs plus pertinents
10.3.8 Création d'une autre couche API

11.
Conception d'API contextuelles
11.1 Adapter la communication aux données, aux objectifs et à la personnalité
11.1.1 Gestion des tâches de longue durée
11.1.2 Notification des événements aux consommateurs
11.1.3 Flux d'événements en continu
11.1.4 Gestion de plusieurs éléments
11.2 Comprendre le contexte complet
11.2.1 Comprendre les pratiques et les contraintes existantes des consommateurs.
11.2.2 Examiner attentivement les limitations du fournisseur
11.3 Choisir le style d'API adapté à votre contexte
11.3.1 Comparaison des API basées sur les ressources, les données et les fonctions
11.3.2 Aller au-delà des API de type requête/réponse et HTTP

12. Documenter les API
12.1 Création d'un document de référence
12.1.1 Documentation du modèle de données
12.1.2 Documenter les objectifs
12.1.3 Documentation de la sécurité
12.1.4 Présentation de l'API
12.1.5 Extraction de documents à partir d'implémentations détaillées : avantages et inconvénients
12.2 Rédaction d'un guide d'utilisation
12.2.1 Documentation des cas d'utilisation
12.2.2 Documentation de la sécurité
12.2.3 Fournir un aperçu des opérations et principes communs.
12.2.4 Penser au-delà de la documentation statique
12.3 Fournir les informations appropriées aux responsables de la mise en œuvre
12.4 Révision et suppression des documents

13.
API en pleine croissance
13.1 Cycle de vie de l'API
13.2 Création de lignes directrices pour la conception d'API
13.2.1 Contenu des lignes directrices de conception d'API
13.2.2 Élaboration continue de lignes directrices
13.3 Examen de l'API
13.3.1 Analyser et remettre en question les exigences
13.3.2 Vérification de votre conception
13.3.3 Analyse de la conception du point de vue du fournisseur
13.3.4 Analyse de la conception du point de vue du consommateur
13.3.5 Vérification de la mise en œuvre
13.4 Communiquer et partager

Image détaillée
Image détaillée 1

Avis de l'éditeur
Ce livre se compose de 3 parties et de 13 chapitres.
Ce livre doit être lu de manière séquentielle, du début à la fin, en abordant tous les chapitres.
Chaque chapitre approfondit les notions abordées dans le chapitre précédent.
Autrement dit, vous devez terminer les chapitres 1, 2 et 3 avant de pouvoir passer aux chapitres qui traitent des sujets de conception.

Partie 1. Principes fondamentaux de la conception d'API

Ce document couvre les concepts et techniques de base nécessaires à la conception d'une API.
Le chapitre 1 explique ce qu'est une API, pourquoi la conception est importante et quels éléments constituent la conception d'une API.
Le chapitre 2 se concentre sur les perspectives des utilisateurs d'API et des logiciels qui consomment l'API, expliquant comment créer des logiciels qui n'exposent pas l'API et comment déterminer les objectifs réels de l'API.
Le chapitre 3 présente le protocole HTTP, l'API REST et le style architectural REST.
Le chapitre 4 présente la spécification OpenAPI et vous montre comment structurer votre API sous la forme d'une description d'API basée sur vos objectifs.

Partie 2.
Conception d'API conviviale

Nous nous concentrons sur la conception d'API faciles à comprendre et à utiliser.
Le chapitre 5 explique comment concevoir des représentations de données simples, des retours d'erreur et de succès, ainsi que des flux d'appels d'API afin que les utilisateurs puissent les comprendre et les utiliser facilement et immédiatement.
Le chapitre 6 explique comment concevoir des API cohérentes, adaptables et faciles à découvrir pour les consommateurs, ce qui leur permet de deviner facilement leur fonctionnement.
Le chapitre 7 vous montre comment comprendre tous les aspects de l'API et comment la configurer et la faire évoluer pour la rendre facile à utiliser.


Partie 3.
Conception d'API contextuelle

Cela vous explique pourquoi les concepteurs d'API doivent prendre en compte l'ensemble du contexte entourant l'API et l'ensemble du contexte entourant le processus de conception d'API lui-même.
Le chapitre 8 explique la sécurité des API et comment concevoir des API sécurisées.
Le chapitre 9 vous montre comment modifier et versionner votre API sans impacter les utilisateurs.
Nous expliquons également comment créer une API facile à mettre à jour.
Le chapitre 10 analyse comment concevoir des API Web efficaces sur le réseau.
Le chapitre 11 examine le contexte global que les concepteurs d'API doivent prendre en compte lors de la conception d'une API.
Cela comprend la coordination des mécanismes de communication, l'évaluation et l'ajustement des limitations des consommateurs ou des fournisseurs, et la sélection d'un style d'API approprié.
Le chapitre 12 explique comment les concepteurs d'API peuvent tirer parti des formats de description d'API comme la spécification OpenAPI pour créer différents types de documentation d'API.
Le chapitre 13 explore l'ensemble du cycle de vie des API et explique comment les concepteurs d'API peuvent participer et contribuer à de multiples API.
Nous examinerons notamment de près les directives de conception des API et les revues d'API.

SPÉCIFICATIONS DES PRODUITS
- Date de publication : 10 novembre 2020
Nombre de pages, poids, dimensions : 448 pages | 1 060 g | 188 × 235 × 23 mm
- ISBN13 : 9788931463224
- ISBN10 : 8931463227
- Certification KC : Type de certification : Confirmation de conformité

Vous aimerez peut-être aussi

카테고리