Sébastien Charrier @scharrier https://bump.sh

QUI UTILISE DES APIS NON DOCUMENTÉES ? 🤚

L’APPROCHE CODE AND DOCUMENT LATER

Nouveau besoin On écrit le code On met en prod On écrira la doc plus tard

〞 EST-CE QUE TU PEUX ÉCRIRE LA DOC EN URGENCE ?

PLUS TARD = JAMAIS

AUJOURD’HUI NOUS AVONS LES OUTILS

API SPECIFICATIONS FTW✌

« AN API SPECIFICATION PROVIDES A BROAD UNDERSTANDING OF HOW AN API BEHAVES AND HOW THE API LINKS WITH OTHER APIS. IT EXPLAINS HOW THE API FUNCTIONS AND THE RESULTS TO EXPECT WHEN USING THE API » https://swagger.io/resources/articles/difference-between-api-documentation-specification/

t c a r t n o C « AN API SPECIFICATION PROVIDES A BROAD UNDERSTANDING OF HOW AN API BEHAVES AND HOW THE API LINKS WITH OTHER APIS. IT EXPLAINS HOW THE API FUNCTIONS AND THE RESULTS TO EXPECT WHEN USING THE API » https://swagger.io/resources/articles/difference-between-api-documentation-specification/

SOAP

APIS REST OPENAPI OPENAPI, RAML, BLUEPRINT

APIS EVENT-DRIVEN ASYNCAPI https://asyncapi.com

GRAPHQL

PROTOBUF

ON PEUT FAIRE TOUT UN TAS DE TRUCS AVEC

ET AVEC LES BONS OUTILS ON PEUT LE FAIRE AUTOMATIQUEMENT

DOCUMENTATION

VALIDER LE COMPORTEMENT DE L’API

MOCKING

GÉNÉRATION DES CLIENTS ET MODÈLES

SYNCHRONISATION DES CHANGEMENTS

COMMENT ON LE CRÉE ?

CODE FIRST DESIGN FIRST

L’APPROCHE CODE FIRST

Nouveau besoin On écrit le code On génère le contrat

L’APPROCHE CODE FIRST THEN ANNOTATE*

DOCUMENTATION VALIDATION DES DONNEES MOCKING GÉNÉRATION DES CLIENTS SYNCHRONISATION DES CHANGEMENTS

DOCUMENTATION VALIDATION DES DONNEES MOCKING GÉNÉRATION DES CLIENTS SYNCHRONISATION DES CHANGEMENTS

VOUS DEVEZ SYNCHRONISER TOUT UN ÉCOSYSTÈME AUTOUR DE VOTRE API.

L’APPROCHE DESIGN FIRST

PRINCIPE : LE CONTRAT EST LA SOURCE UNIQUE DE VÉRITÉ

Nouveau besoin On écrit le contrat Design review On écrit le code Mocking

STOPLIGHT STUDIO

INSOMNIA

ASYNCAPI STUDIO

DOCUMENTATION VALIDATION DES DONNEES MOCKING GÉNÉRATION DES CLIENTS SYNCHRONISATION DES CHANGEMENTS

EST-CE QUE JE DOIS TOUJOURS FAIRE DU DESIGN FIRST ? TM ÇA DÉPEND .

EN 2021, S’IL VOUS PLAÎT, UTILISEZ DES CONTRATS D’APIS 🙏

MERCI 😗

Récupérez du swag en participant à notre recherche utilisateurs / sebastien@bump.sh