RAML une autre façon de concevoir vos APIs RESTful - BreizhCamp 2017 - Tools-in-Action

RAML est le langage de description des API RESTful qui monte et qui gagne à être connu. Ce langage favorise la réutilisation : Don’t Repeat Yourself ! Avec le nombre d’APIs qui augmente constamment, RAML est donc le bienvenu.

Nous verrons donc comment décrire très simplement et rapidement une API, factoriser la description et générer une description interactive à publier en ligne ! Nous adresserons également d’autres activités telles que le mocking, les tests automatisés et la génération de code.

Transcript

1. #BreizhCamp 2017 #RAML ¬ml une autre facon de /ncevoir vos apis restful Sébastien LECACHEUR Vendredi 21 avril - Amphi C - 17h00 @slecache 1
2. #BreizhCamp 2017 #RAML Agenda Contexte RAML Bilan Démos Perspectives 2
3. Dynamite Pin by Kenny_lex under CC BY-NC-SA 2.0 3 #BreizhCamp 2017 #RAML
4. T N T Dynamite Pin by Kenny_lex under CC BY-NC-SA 2.0 3 #BreizhCamp 2017 #RAML
5. Types & Traits Dynamite Pin by Kenny_lex under CC BY-NC-SA 2.0 3 #BreizhCamp 2017 #RAML
6. #BreizhCamp 2017 #RAML Le contexte Pour nos APIs, nous cherchions... 4
7. #BreizhCamp 2017 #RAML Le contexte Pour nos APIs, nous cherchions... Une documentation pour les utilisateurs internes et externes, 4
8. #BreizhCamp 2017 #RAML Le contexte Pour nos APIs, nous cherchions... Une documentation pour les utilisateurs internes et externes, rédigée avant l'implémentation pour une approche contract first, 4
9. #BreizhCamp 2017 #RAML Le contexte Pour nos APIs, nous cherchions... Une documentation pour les utilisateurs internes et externes, rédigée avant l'implémentation pour une approche contract first, gérée comme du code source, 4
10. #BreizhCamp 2017 #RAML Le contexte Pour nos APIs, nous cherchions... Une documentation pour les utilisateurs internes et externes, rédigée avant l'implémentation pour une approche contract first, gérée comme du code source, et lisible par des humains. 4
11. Qui a dit MS Word ? by Ryan McGuire under CC0 1.0 5 #BreizhCamp 2017 #RAML
12. #BreizhCamp 2017 #RAML RESTful API Modeling Language YAML 2013 Mulesoft, AngularJS, PayPal Spécifications sur Vmware, Cisco, Spotify, etc... Restlet, Amazon API Gateway http://raml.org Github 6.1
13. #BreizhCamp 2017 #RAML RAML - Objectifs With RAML you can truly , , , , and your API all with one spec. design build test document share 6.2
14. #BreizhCamp 2017 #RAML RAML - Spec Driven Development 6.3
15. #BreizhCamp 2017 #RAML Le bilan Avec RAML, nous avons obtenu... 7
16. #BreizhCamp 2017 #RAML Le bilan Avec RAML, nous avons obtenu... Une documentation pour tous les utilisateurs et développeurs, 7
17. #BreizhCamp 2017 #RAML Le bilan Avec RAML, nous avons obtenu... Une documentation pour tous les utilisateurs et développeurs, générée automatiquement à partir de code YAML qui est lisible par des humains et versionné sur Git. 7
18. #BreizhCamp 2017 #RAML Le bilan Avec RAML, nous avons obtenu... Une documentation pour tous les utilisateurs et développeurs, générée automatiquement à partir de code YAML qui est lisible par des humains et versionné sur Git. Mais aussi... 7
19. #BreizhCamp 2017 #RAML Le bilan Avec RAML, nous avons obtenu... Une documentation pour tous les utilisateurs et développeurs, générée automatiquement à partir de code YAML qui est lisible par des humains et versionné sur Git. Mais aussi... Un outil et une méthode de conception des APIs, 7
20. #BreizhCamp 2017 #RAML Le bilan Avec RAML, nous avons obtenu... Une documentation pour tous les utilisateurs et développeurs, générée automatiquement à partir de code YAML qui est lisible par des humains et versionné sur Git. Mais aussi... Un outil et une méthode de conception des APIs, ainsi qu'un try it out ! 7
21. #BreizhCamp 2017 #RAML 8
22. #BreizhCamp 2017 #RAML une ressource /characters: 8
23. #BreizhCamp 2017 #RAML une ressource /characters: des verbes get: post: 8
24. #BreizhCamp 2017 #RAML une ressource /characters: des verbes get: post: un identifiant /characters/{id}: patch: get: 8
25. #BreizhCamp 2017 #RAML une ressource /characters: des verbes get: post: un identifiant /characters/{id}: patch: get: un format de représentation response: 200: body: application/json: example: | {"id":1, "name":"Walter White"} 8
26. #BreizhCamp 2017 #RAML une ressource /characters: des verbes get: post: un identifiant /characters/{id}: patch: get: un format de représentation response: 200: body: application/json: example: | {"id":1, "name":"Walter White"} Votre premier RAML ! 8
27. Assez parlé ! Code by Crusher95 under CC BY-SA 4.0 9.1 #BreizhCamp 2017 #RAML
28. #BreizhCamp 2017 #RAML Démo édition - API Workbench + 1ière API documentation raml2html api:Console mocks - osprey-mock-service tests - abao (RAML 0.8) top-down en Java (2.0.0-RC2) Maven/JAX-RS : génération des sources Maven/JAX-RS : serveur Jersey 9.2
29. Don't Repeat Yourself Egyptian Clones by Guillaume DELEBARRE under CC BY-NC-ND 2.0 10 #BreizhCamp 2017 #RAML
30. Explosion by mikegi under CC0 1.0 11 #BreizhCamp 2017 #RAML
31. T N T Explosion by mikegi under CC0 1.0 11 #BreizhCamp 2017 #RAML
32. Types & Traits Explosion by mikegi under CC0 1.0 11 #BreizhCamp 2017 #RAML
33. Take away by Vee O under CC0 1.0 12.1 #BreizhCamp 2017 #RAML
34. #BreizhCamp 2017 #RAML Aller plus loin RAML 1.0 : data types, annotations, overlays, libraries, security schemes, etc... Parseurs RAML Image Docker $ docker run slecache/api-console https://github.com/raml-apis http://api.yaas.io/patterns/ 12.2
35. #BreizhCamp 2017 #RAML Ce qu'il faut retenir contract first : cycle rapide de conception mais impose de la rigueur une documentation très claire Types & Traits Undisturbed REST 12.3
36. A vous de jouer et concevoir vos APIs... That's all folks by Warner Bros. under public domain 13 #BreizhCamp 2017 #RAML