Home » Formation: Réaliser vos guidelines d’APIsation

Formation: Réaliser vos guidelines d’APIsation

Fixez les règles de conception et de gouvernance des API de votre organisation pour une amélioration continue.

API Développement vous propose une formation pour constituer vos guidelines d’APIsation ou RefCards API qu’elles concernent le cycle de vie, la gouvernance auprès de toutes les parties prenantes mais aussi les règles d’implémentation et d’exposition.

Vous commencez à constituer votre patrimoine d’API et il est nécessaire de fixer les règles de conception et d’exposition. Cette formation vous permet d’évoquer les axes de standardisation avec l’ensemble des parties prenantes tout au long du cycle de vie de vos API. L’image et la qualité des API exposées par l’organisation sont en jeu : leur homogénéité et lisibilité pour un usage accéléré et maximal. C’est une formation préalable à celle dédiée au design de la spécification OpenAPI (ex swagger).

Durée: 1 jour
Pré-requis de la formation : Concevoir vos guidelines et refcards API
Public : API Managers et API Governors, Chefs de projet , Lead développeurs et éventuellement
développeurs,
Product Owners et Product Managers,
Business Analysts comme liaison avec les métiers et, bien entendu, toute instance managériale de la DSI.
Fixer de façon optimale les règles et y adhérer est nécessaire pour l’ensemble des parties prenantes :
– Etre Client-centric donc offrir des swaggers ou OpenAPI spécification lisibles et efficients
– Optimiser les API en taille et en « Produits »
– Sensibiliser les développeurs sur une conception fonctionnelle avant la « première » ligne
de code du web service de l’API
– Rendre les API managers et gouverneurs, chef de projets, Product Owner sensibles à la qualité
de la documentation et aux process du design jusqu’à l’exposition
– Apporter les éléments nécessaires au Business Analyst pour spécifier ses APIs afin d’avoir
une implémentation conforme aux attendus
– Apporter les éléments nécessaires aux décideurs pour insuffler et porter ces démarches nécessaires
à l’image de marque de leur organisation mais surtout à son efficience.

PROGRAMME
Enjeu d’une standardisation du design d’API dans la conception fonctionnelle :

L’esprit “API First” et “Design First”
– API vs Microservices
– L’alignement sur l’ontologie d’entreprise
– Etude d’opportunité
– Typologies d’API
– Définir les éléments minimaux d’une API (cycle de vie et périmètre des ressources)
– Security by design (technique et fonctionnelle)
– Web services de backend versus API exposée dans un portail …
– L’approche Data Centric
– Confidentialité et obligations légales
– Morphologie des ressources, sémantique, modélisation minimale
– L’écriture du swagger ou de l’OpenAPI Specification : d’une version préliminaire jusqu’à une version aboutie
– Rigueur et souplesse de l’application des règles et principes retenus
– La notion de « produit d’API »
– L’API Manager médiateur et compensateur

Revue des grandes familles de règles de design et de nommage :
– Nommages et formats des données
– Sizing
– Headers and Bodies
– Les verbes, basepaths et ressources
– Gestion des status codes
– Versionning
– Schéma de données
– Pagination, ordering, filtering, …
– Le Produit
NB : une formation de deux jours est dédiée à cet axe, en approfondissement, pour la réalisation des swaggers / OpenAPI
Specification.

Fixation de règles de gouvernance opérationnelles
– Doctrine avec les Parties Prenantes ?
– L’écriture d’une charte corporate ?
– la déclaration de “l’asset API”
– L’impact du CI/CD et du DevSecOps
– Mockup
– Consommation
– Sécurisation
– Limitations (quotas, limitation des ressources, …)
– Autorisation et authentification
– Versionnement
– Décommissionnement
– Observabilité optimale
– Maintenance facilitée
Prérequis : aucun

Formation suivante : “Concevoir vos guidelines et refCards API” de notre organisme
Prix : sur demande
(possibilité d’organiser une formation de plusieurs collaborateurs au sein d’une même
société autour d’un sujet contextualisé )