Créer une API REST en moins de 30 secondes

J’ai longtemps cherché un truc qui me permette de créer facilement une API REST sans passer trop de temps à coder/débugguer. Il y’a quelques trucs sympas mais pas aussi sympa que ce que je vais vous détailler :)

Cest un service crée avec amour par Typicode. Un server json qui permet de manipuler via un accès HTTP les données stockées dans un fichier JSON. Il faut juste installer Json-server

Une fois le dépôt json-server installé, vous pouvez passer des requêtes GET, PUT, DELETE, …Etc

Installation de json-server

Pour pouvoir utiliser json-server, il faut installer node.js

Ensuite, l’installation se fait avec NPM

npm install -g json-server

Vous avez maintenant un nouveau binaire dans votre $PATH pour lancer le serveur : json-server.

Utilisation de l’API

Tout d’abord, vous devez créer un fichier JSON contenant vos données. Ces données seront accèssibles et manipulables via votre tout nouveau serveur d’API.

Admettons que mon fichier s’appelle db.json et ressemble à ce qui suit:


{
  "posts": [
    { "id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ]
}

A ce stade, il ne vous reste plus qu’à démarrer votre serveur pour avoir accès à l’API Rest.


json-server -f db.json -p 2707

Ouvrez-votre navigateur et aller à l’URL http://localhost:2707/. Vous êtes sensé une vue sur votre API et pouvez passer tout type de methode HTTP pour manipuler vos données.

Si vous vous aventurez sur cette URL, vous aurez le résultat suivant:


{ "id": 1, "title": "json-server", "author": "typicode" }

Les routes disponibles dans votre API

Avec le json ci-dessus, vous avez accès à tout un tas de routes:


GET   /posts
GET   /posts/1
GET   /posts/1/comments
GET   /posts?title=json-server&author=typicode
POST  /posts
PUT   /posts/1
PATCH /posts/1
DEL   /posts/1

Pour aller plus loin, la doc est ici: https://github.com/typicode/json-server