JDONREFv4 introduction

De JDONREF Wiki
Révision de 18 mars 2014 à 23:01 par Julien2512 (discussion | contributions) (API & spécifications)

JDONREFv3ES : Introduction

NB : La documentation décrite dans ce wiki est en cours de rédaction, et le service n'est pas encore implémenté.

JDONREFv3ES est le service de JDONREF qui permet d'utiliser un backend ElasticSearch tout en conservant les signatures de méthode actuelles de JDONREF en SOAP.

JDONREFv3REST est le service de JDONREF qui permet de l'utiliser sous la forme d'appels suivant la philosophie REST.

Il est bien sûr possible d'utiliser JDONREFv3REST avec JDONREFv3ES.

API & spécifications

JDONREFv3ES API

JDONREFv3REST API

Types Elastic Search

Philosophie de JDONREFv3REST

La philosophie suivie pour l'implémentation de JDONREFv3REST est d'être compatible avec l'API REST de ElasticSearch. Il s'agit plus précisément d'un sous-ensemble de l'API REST d'ElasticSearch. Ainsi, une application développée pour utiliser JDONREFv3REST pourrait aussi fonctionner en utilisant ElasticSearch.

Par exemple, l'API Search d'Elastic search ([1]) propose de rechercher une adresse d'un index jdonref de cette manière :

curl -XGET 'http://localhost:9200/jdonref/adresse/_search?q=hopital'

C'est exactement cette syntaxe qui sera reprise dans JDONREFv3Rest pour la validation d'adresse. L'API sera simplement étendue aux fonctions actuellement non présentes dans ElasticSearch.

Philosophie de JDONREFv3ES

Le périmètre de JDONREF est actuellement plus étendu que celui de ElasticSearch car il est spécialisé dans le traitement d'adresses. Il s'agit des fonctions :

  • de normalisation ;
  • de restructuration ;
  • de découpage ;
  • de géocodage (ElasticSearch proposant l'indexation géographique, mais pas le calcul de l'interpolation du tronçon) ;

JDONREFv3ES s'appuie donc sur les traitements existants de JDONREF pour ces 4 fonctions, mais utilise les fonctionnalités de ElasticSearch pour la validation et le géocodage inverse.