Créer des API REST en Java avec une approche API-First : Mise en pratique et retours d'expérience

Vous êtes vous déjà retrouvé dans la situation ou la documentation des API n'était pas à jour ou tout simplement fausse ? Cette situation est principalement dû au fait que celle-ci est faite soit a posteriori ou que les outils de génération ne sont pas adaptés.

Dans le cadre du développement des API, nous opposons trop souvent les approches Code-First aux approches API-First. La plupart des développeurs préfèrent la première car elle est plus centrée sur le code et la documentation est générée automatiquement. Malheureusement, de la seconde on ne retient trop souvent que les mots "documentations" ou "spécifications".

Cependant, la conception et la mise en œuvre d'une approche API-First offrent de nombreux avantages : garantie que les implémentations sont compatibles avec les spécifications, automatisation de la validation des API publiées et surtout, amélioration de l'expérience développeur de vos clients.

Dans cet atelier, une API développée en Java avec Spring, nous allons passer du mode "Code-First" en API-First" en utilisant les dernières pratiques et outils tels qu' OpenAPI Generator et OAS-DIFF.

Nous verrons donc comment relever ce grand défi : améliorer la qualité de votre API, favoriser son adoption par vos clients et, surtout, faire en sorte que vos développeurs puissent adorer écrire et manipuler de la documentation d'API.