Création d’une API

1. Serveur

Le paramètre idle-timeout correspond au temps à partir duquel une connexion inactive est fermée. Par défaut, sa valeur est de 60 secondes et si on veut supprimer ce comportement, il faut spécifier sa valeur à "infinite".

idle-timeout = 60 s 

Le paramètre request-timeout correspond au temps par défaut à partir duquel une réponse est considérée comme en timeout (délai dépassé). Le timer se lance à partir de la fin de la réception de la requête. Par défaut, sa valeur est de 20 secondes. 

request-timeout = 20 s 

Le paramètre default-http-port correspond au port à utiliser lorsqu’aucun autre port n’est spécifié. Par défaut, c’est le port 80 qui est utilisé.

default-http-port = 80 

Le paramètre pipelining-limit correspond au nombre maximum de requêtes acceptées...

1. get

Par défaut, le type de requête effectuée est le get. En lançant la commande curl suivie de l’URL souhaitée, on effectue une requête get vers cette URL.

~ curl https://jsonplaceholder.typicode.com/todos/1 
{ 
 "userId": 1, 
 "id": 1, 
 "title": "delectus aut autem", 
 "completed": false 
}% 

Pour obtenir la réponse complète, notamment le code de retour, les headers et le corps, il faut renseigner l’option -i :

~ curl https://jsonplaceholder.typicode.com/todos/1 
HTTP/2 200 
[...] 
{ 
 "userId": 1, 
 "id": 1, 
 "title": "delectus aut autem", 
 "completed": false 
}% 

2. post

Pour effectuer un post, on renseigne l’option -d ou --data suivie du corps de la requête correspondant souvent à l’objet...

1. Définition

Pour créer un serveur, il faut définir plusieurs éléments :

Un acteur système permet de créer plusieurs threads et de répartir les tâches sur ces derniers. Dans notre exemple, nous n’allons pas gérer d’acteurs différents et utiliserons l’acteur système par défaut nommé avec la classe.

implicit val system: ActorSystem = ActorSystem("serveur-app") 

Le contexte d’exécution est nécessaire dans le cas d’opérations asynchrones et d’utilisation de Future. On utilise le contexte fourni par l’acteur système qui permet de répartir les tâches sur les threads disponibles.

implicit val executor: ExecutionContext = system.dispatcher 

Une route est représentée par un chemin et une action correspondante. Le type Route est défini comme une fonction qui prend en entrée un contexte et qui renvoie un résultat de type Future :

type Route = RequestContext => Future[RouteResult] 

Lorsqu’une route reçoit une requête, matérialisée par le type RequestContext, il est possible de renvoyer une réponse en effectuant une des directives suivantes :

De par sa définition, une route peut être tout simplement décrite par une fonction :

val route = { contexte => 
 contexte.complete("Complétion de la route") 
} 

Cette route sera liée au chemin "/" et à la méthode http get. Elle renvoie une réponse contenant le message spécifié et un code de retour 200 (Ok).

Pour créer le serveur à partir de ces éléments...

1. Définition du client

Pour créer un client, il faut définir plusieurs éléments :

Comme dans la partie serveur, nous allons prendre un ActorSystem et un ExecutionContext par défaut.

implicit val system: ActorSystem = ActorSystem("client-app") 
implicit val executor: ExecutionContext = system.dispatcher 

Pour pouvoir lancer des requêtes, on crée un objet de type HttpExt avec le constructeur Http.

private val http = Http() 

Avec cet objet, on peut exécuter des requêtes de type HttpRequest avec la méthode singleRequest.

2. Création d’une requête

Une requête est représentée par un objet de type HttpRequest. Elle est constituée des éléments suivants :

Les méthodes Http sont listées dans l’objet HttpMethods ; on y retrouve les méthodes abordées dans la partie cURL :

Les headers sont représentés par le trait RequestHeader ; il existe des classes qui décrivent des headers particuliers comme :

Pour tous les headers qui ne sont pas définis dans une classe, on utilise la classe RawHeader qui prend comme arguments un nom et une valeur.

Une entité est représentée par la classe HttpEntity qui prend comme arguments un type de contenu et le contenu lui-même sous forme de String ou de byte[]. Les types de contenus sont définis dans l’objet ContentTypes qui contient les types suivants :

Le protocole Http est représenté par la classe HttpProtocol et tous les protocoles disponibles sont définis dans l’objet HttpProtocols :

3. Traitement de la réponse...