Développer l’API du siècle, c’est une chose. Faire en sorte qu’elle soit utilisée correctement, c’en est une autre. Lorsqu’on développe un service à destination de développeurs, il y a de grandes chances pour que la Documentation et la DX (Developer eXperience) prennent une place importante dans notre quotidien.

Pour rendre le processus efficace et maintenable, il existe des standards (comme OpenAPI) et surtout un module spring, le fameux Spring-doc.

Malheureusement, entre “utiliser spring-doc et les annotations Swagger” et “avoir une excellente DX sur la documentation de mon service”, il y a un monde.

Dans ce talk, je vous fais découvrir les marches qu’il manque pour que vos documentations d’API deviennent d’une efficacité redoutable, au point que même vos managers seront en mesure de les comprendre. Le but est aussi de montrer qu’une fois correctement mise en place, elle peut être maintenue et mise à jour avec un minimum d’effort.