Ketting a pour objectif de devenir une API cliente générique Hypermedia (HATEOAS) pour JavaScript et TypeScript que ce soit via Node.js ou dans les navigateurs. Ce qui veut dire qu'il prend en charge un ensemble de fonctionnalités modernes que les services REST pourraient avoir. L'idée est également de fournir une interface RESTful permettant de suivre de manière stricte les bonnes pratiques REST.La bibliothèque utilise l'API Fetch et supporte plusieurs formats de données :
- HAL, pour Hypertext Application Language ;
- JSON:API ;
- Siren, une interface structurée pour représenter des entités ;
- Web Linking (header HTTP Link), un modèle de relations entre les ressources et des types ;
- les link HTML5.
L'auteur, Evert Pot, donne l'exemple suivant :
| Code js : | Sélectionner tout |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | const ketting = new Ketting('https://api.example.org/'); // Retrouver un lien avec rel="author". Cela pourrait être un "<link>" HTML5, // un "_links" HAL ou un "Link:" HTTP. const author = await ketting.follow('author'); // Obtenir l'état actuel. const authorState = await author.get(); // Modifier la propriété firstName de l'objet. authorState.firstName = 'Evert'; // Sauvegarder le nouvel état. await author.put(authorState); |
Contrairement à la plupart des autres bibliothèques, Ketting ne se base pas sur les URI, mais sur les types de relations et les liens. Car un principe de base de la construction d'un bon service REST, est que les URI doivent être découvertes et non codées en dur dans une application.
Site officiel.