ALOM

🤝 Interoperability

UBER

Problématique

Comment communiquer avec les autres micro-services?
Comment communiquer avec les partenaires?

Contraintes ⛓

Toutes les applications ne sont pas écrites dans le même langage (Java, .Net, NodeJS, PHP, Ruby, Python...)

Les partenaires n'ont pas forcément les mêmes environnements (réseaux, firewall)

Solution 🎉

Définition d'une norme de communication, basée sur des standards.

Web services & web-sockets 🌍

Protocole HTTP(S)
- Facile à implémenter (texte)
- Passe les firewalls (port 80/443)
- Sécurisation avec SSL/TLS 🔒
Formats de données
- SOAP : XML
- REST : JSON
Contrat de service
- SOAP : WSDL
- REST : Swagger...

Web services SOAP 🛁

Web services SOAP

Simple

Object

Access

Protocol

Web services SOAP

Principes architecturaux

Protocole de type RPC (Remote Procedure Call)
Représentation XML (Enveloppe, Header, Body) ✉️
S'appuie sur HTTP, ou tout autre protocole (SMTP, JMS...)

## Web services SOAP
                    ### Exemple de WSDL

```xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?><wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:sch="http://spring.io/guides/gs-producing-web-service" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://spring.io/guides/gs-producing-web-service" targetNamespace="http://spring.io/guides/gs-producing-web-service">
  <wsdl:types>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://spring.io/guides/gs-producing-web-service">

<xs:element name="getCountryRequest">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="name" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

<xs:element name="getCountryResponse">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="country" type="tns:country"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

<xs:complexType name="country">
        <xs:sequence>
            <xs:element name="name" type="xs:string"/>
            <xs:element name="population" type="xs:int"/>
            <xs:element name="capital" type="xs:string"/>
            <xs:element name="currency" type="tns:currency"/>
        </xs:sequence>
    </xs:complexType>

<xs:simpleType name="currency">
        <xs:restriction base="xs:string">
            <xs:enumeration value="GBP"/>
            <xs:enumeration value="EUR"/>
            <xs:enumeration value="PLN"/>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>
  </wsdl:types>
  <wsdl:message name="getCountryResponse">
    <wsdl:part element="tns:getCountryResponse" name="getCountryResponse">
    </wsdl:part>
  </wsdl:message>
  <wsdl:message name="getCountryRequest">
    <wsdl:part element="tns:getCountryRequest" name="getCountryRequest">
    </wsdl:part>
  </wsdl:message>
  <wsdl:portType name="CountriesPort">
    <wsdl:operation name="getCountry">
      <wsdl:input message="tns:getCountryRequest" name="getCountryRequest">
    </wsdl:input>
      <wsdl:output message="tns:getCountryResponse" name="getCountryResponse">
    </wsdl:output>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="CountriesPortSoap11" type="tns:CountriesPort">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="getCountry">
      <soap:operation soapAction=""/>
      <wsdl:input name="getCountryRequest">
        <soap:body use="literal"/>
      </wsdl:input>
      <wsdl:output name="getCountryResponse">
        <soap:body use="literal"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="CountriesPortService">
    <wsdl:port binding="tns:CountriesPortSoap11" name="CountriesPortSoap11">
      <soap:address location="http://localhost:8080/ws"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>%
                    ```

---

### Exemple de requête

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
				  xmlns:gs="http://spring.io/guides/gs-producing-web-service">
   <soapenv:Header/>
   <soapenv:Body>
      <gs:getCountryRequest>
         <gs:name>Spain</gs:name>
      </gs:getCountryRequest>
   </soapenv:Body>
</soapenv:Envelope>
                    ```

---

### Exemple de réponse

```xml
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:getCountryResponse xmlns:ns2="http://spring.io/guides/gs-producing-web-service">
      <ns2:country>
        <ns2:name>Spain</ns2:name>
        <ns2:population>46704314</ns2:population>
        <ns2:capital>Madrid</ns2:capital>
        <ns2:currency>EUR</ns2:currency>
      </ns2:country>
    </ns2:getCountryResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
                    ```

En Java ☕

2 possiblités d'implémentation

Contract-first (top-down) ⬇️
Code-first (bottom-up) ⬆️

Contract-first

Approche historique

Rédaction d'un contrat WSDL (ouch!) 💢 🤕

Récupération d'un contrat d'un partenaire

Génération d'un stub(client) et d'un squeleton(server) Java

Contract-first

Génération du code avec un plugin maven:

Code-first

Approche plus simple 😎

Écriture des classes/interfaces Java

Génération du WSDL à partir des classes (annotations/méthodes etc...)

Code-first

Web services REST

REpresentational

State

Transfert

Web services REST

Principes architecturaux

Architecture découplée client/serveur
Sans état (pas de session)
Accès à des ressources:
- Identifiées de manière unique
- Manipulées via des représentations (JSON, XML, HTML...)
- Compatible avec une mise en cache
- Données Hypermédia

Négociation de contenu

Principes au coeur du web

Le client indique au serveur ses attentes via des headers HTTP

Négociation de contenu

Format des données : header Accept
Traduction : header Accept-Language
Retour avec les headers Content-Type et Content-Language

La RFC 4229 liste les headers possibles.

Web services REST

HATEOAS : Hypermedia As The Engine Of Application State

Le message contient les informations permettant de manipuler l'application

Web services REST : Exemple XML

Web services REST : Exemple JSON

HATEOAS

Excellent talk de Julien Topçu

Contrat de service REST

OpenAPI (ex Swagger)

OpenAPI est la spec, Swagger une implémentation

Description des API au format JSON ou YAML : OpenApi

Rendu Web + "Try It" : Swagger

Pokemon API

Swagger et OpenApi en Spring Boot

Pas d'implémentation de la part de Spring

1 projet Open Source

springdoc-openapi (doc)

Exposition d'un service REST Spring

En Spring

/api/pokemon-types/{id}

/api/pokemon-types?orderBy=name

/api/pokemon-types?type=poison

@RequestMapping : écouter une URI
@PathVariable : récupérer les variables d'URI entre '{}'
@RequestParam : récupérer les paramètres de requête (query-strings '?a=b&c=d')
@RequestBody : récupérer le corps de la requête

@RequestMapping

/api/pokemon-types

@PathVariable

/api/pokemon-types/{id}

@RequestParam

/api/pokemon-types?orderBy=name

@RequestParam

/api/pokemon-types?type=poison

@RequestBody

POST /api/trainers

Spring RestTemplate

Classe utilitaire pour effectuer des appels REST

Exécute les requêtes HTTP : GET/POST/PUT/PATCH/OPTIONS/DELETE/HEAD
Utilise jackson-databind pour convertir les objets Java en JSON !

Outillage

💪 `$> curl`

Postman/Insomnia

Les autres moyens de communication réseau

Reactive Streams - Support avec Spring WebFlux
GraphQL - Support avec Spring GraphQL
gRPC - pas d'implémentation officielle

TP

Interoperability

ALOM

🤝 Interoperability

UBER

Problématique

Contraintes ⛓

Solution 🎉

Web services & web-sockets 🌍

Web services SOAP 🛁

Web services SOAP

Web services SOAP

Principes architecturaux

En Java ☕

2 possiblités d'implémentation

Contract-first

Contract-first

Code-first

Code-first

Web services REST

Web services REST

Web services REST

Principes architecturaux

Négociation de contenu

Négociation de contenu

Web services REST

HATEOAS : Hypermedia As The Engine Of Application State

Web services REST : Exemple XML

Web services REST : Exemple JSON

HATEOAS

Contrat de service REST

OpenAPI (ex Swagger)

Swagger

Swagger

Swagger

Swagger et OpenApi en Spring Boot

En Spring

@RequestMapping

@PathVariable

@RequestParam

@RequestParam

@RequestBody

Spring RestTemplate

Outillage

💪 $> curl

Postman/Insomnia

Les autres moyens de communication réseau

TP

💪 `$> curl`