Rédigez et partagez les règles de design et d’exposition documentées des API de votre organisation.
API Développement vous propose une formation pour créer vos guidelines ou refCards d’API. En abordant les constituants d’un produit d’API et de l’API elle-même, les éléments descriptifs et implémentés de celle-ci sont disséqués pour arbitrage sur l’adhésion à un standard propre ou habituel des web services REST.
Cette doctrine documentée permettra à l’ensemble des parties prenantes de travailler dans le même sens en comprenant l’enjeu des règles, d’une conception avant “la première ligne de code” et d’une documentation embarquée pour mettre en valeur son produit auprès des consommateurs.
Formation Concevoir vos guidelines et refCards API |
| Durée: 2 jours Approfondissement de la formation : Réaliser vos guidelines d’Apisation |
Public : API Managers et API Governors, Chefs de projet – Product Owners , Lead développeurs et éventuellement développeurs. |
| Connaître les constituants de la documentation et de l’exposition des API pour choisir et arbitrer sur les règles de design : Identification, périmètre et destination (consommateurs) des assets (Produits d’API et l’API) Nommage des assets Constituants du swagger ou de l’OpenAPI Specification Nécessité du design des éléments des ressources Alignement ou compensation dans l’API Manager des web services de backend Versionning Healthcheck Quotas, limitations, bouchonnage Eléments d’observabilité Outillage complémentaire à l’API Manager |
PROGRAMME |
Notion de Produit d’API et d’API (périmètre) : – Définitions – API vs Microservices – Exigences sur ces deux assets – Règles de nommage – API Throttling vs API Rate Limiting – Versionning et rétrocompatibilité – Morphologie du swagger / de l’OpenAPI Specification: Les case types – Headers et tags – Verbes/opérations – Basepaths et Ressources, facettes – Identifiant et query-params – Status codes – Définitions des objets – Pagination, ordering, filtering, caching… – Healthcheck – Découvrabilité – Observabilité – Limite de règles trop strictes en étant confronté à la réalité … Panorama d’outillages : -Apitools (Ecriture et contrôle sémantique) – Mermade (Transduction) – Apidog, Karate Mock Server, Postman, Beeceptor (Mockup) – Spectral, 42Crunch (Conformité, Audit, Sécurité) – Loader.io (Stress test) – Datadog and SigNoz (Obervabilité) … |
Prix: sur demande (possibilité d’organiser une formation de plusieurs collaborateurs au sein d’une même société autour d’un sujet contextualisé ) |