Spécifications de webservices avec un seul outil

DOCUMENTER, TESTER, ET
BOUCHONNER VOS WEBSERVICES
AVEC UN SEUL OUTIL
C’est possible !
Nantes, jeudi 14 juin 2018

2//
Julie ROLLIN-MOUSTÉOU
Formation
Expériences
Développement JAVA chez Amadeus - Conseil en SI chez Deloitte -
Business Development chez Tech4Team (édition de logiciels) -
Product Management chez FABERNOVEL TECHNOLOGIES.
Projets
Senior Product Manager
# Gestion de projet
# Spécifications
fonctionnelles
# Webservices
# Process - Formation

3//
Qui a déjà rencontré un
crash en front dû à une
réponse de webservice
non conforme à la
spécification initiale ?

4//
Qui a déjà entendu parlé
des JSON Schema ?

5//
01 //
Des problèmes récurrents ?

6//
Design UX/UI
IS legacy opening and
integraton
Front end web
Big Data, Smart
Data, Fast Data
Back end web
AI
(chat bots, machine
learning…)
SaaS - PaaS / Cloud IOT
Mobile Apps
(development,
product
management)
API management
Front end web
Architecture
Devops

7//
Clients, Product/Project Managers et Développeurs
Quand un client rencontre un crash sur son application mobile...
Mon application
a crashé !!!

8//
En tant qu’interlocuteur opérationnel privilégié du client, le Project Manager cherche la source du problème
Nous investiguons la
source du problème.
Mon application
a crashé !!!

9//
Le Project Manager regarde les logs du crash et identifie que le crash se produit lors d’un appel au webservice
D’où cela peut-il bien venir ?
Regardons les logs...
Cela semble lié à un appel côté
webservice !
Mon application
a crashé !!!
Nous investiguons la
source du problème.

10//
Le Project Manager demande à son développeur la source exacte du problème et comment il peut régler ce crash !
Tu pourrais m’en dire plus ?
Et tu pourrais corriger le souci stp ?
J’ai remarqué que le crash se produisait
lorsqu’on faisait cet appel…
C’est assez critique pour
ma cliente...

11//
Le développeur donne son diagnostic...
yes je vois tout à fait pourquoi
l’application crash à cet endroit précis...

12//
Le développeur donne son diagnostic : la spécification webservice initiale ne correspond pas à la réponse actuelle !
… c’est parce que la réponse actuelle que je reçois du webservice n’est pas la même que
celle contenue dans les spécifications utilisées au moment du développement !

13//
Chacun se demande quelle est la source de vérité… ???
À quelles spécifications
faisons-nous référence ?
C’est la version 1.5.0
envoyée début Avril non ?
La dernière que j’ai reçue
c’est la version 1.9.8 !
Moi j’avais la
version 1.9.7...

14//
Hier : différents outils pour documenter, tester ou bouchonner des webservices
#2
TESTER
#1
DOCUMENTER
#3
BOUCHONNER

15//
DOCUMENTER
(e.g. Word, Swagger)

16//
DOCUMENTER
TESTER
(e.g. POSTMan)

17//
BOUCHONNER
(e.g. WireMock)
DOCUMENTER
TESTER
(e.g. POSTMan)

18//
BOUCHONNER
(e.g. WireMock)
DOCUMENTER
TESTER
(e.g. POSTMan)

20//
Avoir une seule
et unique source
de vérité !
Quel est notre but ?

21//
Trois options possibles
Trouver un outil du marché
(POSTMan, Restlet intègrent de plus en
plus de features !)
01

22//
plus de features !)
Synchroniser différents outils
Forte dépendance aux autorisations
d’accès pour chaque outil
01
02

23//
plus de features !)
Construire
un nouvel outil
01
02
03

24//
plus de features !)
Construire
un nouvel outil
01
02
03

25//
02 //
Comment spécifier un unique JSON ?

26//
JSON
{
"user": {
"id": 1200,
"firstname": "Arthur",
"lastname": "Martin",
"age": 17
}
}
Exemple

27//
JSON Schema
{
"title": "user",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"age": {
"type": "integer",
"minimum": 0
}
}
}
Représente la structure d’un JSON spécifique

28//
JSON Schema
À quoi sert un JSON Schema ?
DOCUMENTER
JSON Schema
TESTER
BOUCHONNER

29//
03 //
Comment spécifier toute une API avec
des JSON Schemas ?

30//
Ressources
Exemple : un utilisateur
User

31//
Attributs d’une ressource
{
"user": {
"id": 1200,
"firstname": "Arthur",
"lastname": "Martin",
"age": 17
}
}
Exemple de JSON
User
id
firstname
lastname
age

32//
LIRE les données d’un
utilisateur
GET /users/:id
Routes
CRÉER un nouvel
utilisateur
POST /users
METTRE À JOUR les
données d’un
utilisateur
PUT /users/:id
SUPPRIMER les
données d’un
utilisateur
DELETE /users/:id

33//
Documentation d’un webservice
Tout un projet !
PROJET
RESSOURCES
ATTRIBUTS ROUTES

34//
Tout un projet !
PROJET
RESSOURCES
ATTRIBUTS ROUTES
REQUÊTES RÉPONSES

35//
Représentations de ressource
Exemple : CRÉER un nouvel utilisateur
User
firstname
lastname

36//
Exemple : CRÉER un nouvel utilisateur
{
"title": "user",
"type": "object",
"properties": {
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"required": ["firstname", "lastname"]
}
}
User
firstname
lastname
POST /users - Corps de la requête

37//
Exemple - LIRE les données d’un utilisateur
{
"title": "user",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"age": {
"type": "integer",
"minimum": 0
},
"required": [“id”,"firstname", "lastname"]
}
}
User
id
firstname
lastname
age
GET /users/:id - Corps de la réponse

38//
L’ensemble des requêtes et des réponses
peuvent être décrites
par des représentations
de ressource.
REPRÉSENTATIONS DE RESSOURCES
PROJET
RESSOURCES
ATTRIBUTS ROUTES
REQUÊTES RÉPONSES

39//
Spécifications d’un webservice au global
TOUTES les routes du projet utilisent des représentations de ressource

40//

41//
{defaultUser}
{userCreation}
{userUpdate}
{defaultHouse}
{userHouseUpdate}
...
{defaultCar}
{userCarUpdate}
...
{defaultJob}
{userJobUpdate}
...

42//
Tout un projet spécifié grâce aux
représentations de ses ressources !
Collection de JSON SCHEMA
REPRÉSENTATIONS DE RESSOURCES
PROJET
RESSOURCES
ATTRIBUTS ROUTES
REQUÊTES RÉPONSES

43//
04 //
Pourquoi le JSON Schema est si peu
utilisé ?

44//
Il peut s’avérer très complexe à écrire...

45//
La clef du succès est dans l’ombre !
ABSTRACTION DES JSON SCHEMA
INTERFACE UTILISATEUR SCHÉMA MANAGEMENT

46//
05 //
Problèmes résolus !

47//
Clients et Product/Project managers
Perte de temps infinie en tentant de reproduire le cas qui a causé le crash...
Mon application crash
encore et toujours...
Je regarde !
OK je suis partie pour des heures de tests pour tenter
de reproduire le cas qui a causé le crash...

48//
Des tests facilités grâce à au proxy intégré dans la solution
Client ServeurProxy

49//
Product/Project managers et Développeurs
Perte de temps infinie dans la mise à jour de la documentation et des bouchons des webservices...
Pourrais-tu mettre à jour les
spécifications webservices du coup stp ?
Bien sûr...
Je dois modifier tout un tas de fichiers, des bouchons
et de la documentation... Quel cauchemar !

50//
Une documentation à jour et téléchargeable

51//
BouchonClient
Des bouchons de webservices mis à jour quand la documentation est modifiée

52//
Clients, Products/Project managers et Développeurs
Il n’y a plus de souci - gain de temps effectif pour tout le monde !
Mes spécifications sont
toujours à jour
Je peux savoir rapidement
quand la documentation
est obsolète
Mettre des spécifications
et des bouchons à jour est
devenu beaucoup plus
simple !

55//
https://github.com/applidium/pericles

56//
https://github.com/applidium/pericles
Btw : on recrute !!!!
https://careers.fabernovel.com/

Merci.
57//
Julie ROLLIN-MOUSTÉOU
Senior Product Manager @FABERNOVELTECHNOLOGIES
julie.rollin@fabernovel.com
https://www.linkedin.com/in/julie-rollin-mousteou/
@JulieRolMous

Spécifications de webservices avec un seul outil

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Ähnlich wie Spécifications de webservices avec un seul outil

Ähnlich wie Spécifications de webservices avec un seul outil (20)

Mehr von Fabernovel

Mehr von Fabernovel (20)

Spécifications de webservices avec un seul outil