Project

General

Profile

Actions

Feature #3840

closed

Recherche : API Rest

Added by Nicolas Eysseric about 9 years ago. Updated about 5 years ago.

Status:
Closed
Priority:
Normal
Category:
Moteur de recherche
Target version:
Start date:
10/22/2012
Due date:
% Done:

0%

Estimated time:
Livraison en TEST:
Livraison en PROD:

Description

L'objectif de cette évolution est d'exposer le moteur de recherche via une API Rest.
Dans un premier temps, seule la recherche plein texte simple sera supportée.

Chaque résultat retourné sera constitué des informations suivantes :
  • son titre,
  • sa description,
  • sa date de dernière modification,
  • le lien d'accès dans Silverpeas,
  • sa pertinence,
  • l'identité du contributeur,
  • son emplacement complet dans Silverpeas

Des résultats seront retournés uniquement si la clé d'API est fournie et qu'elle est valide (associée à un compte non supprimé).

Actions #1

Updated by Anonymous over 6 years ago

  • Status changed from New to Assigned
  • Assignee set to Anonymous
Actions #2

Updated by Anonymous over 6 years ago

  • Status changed from Assigned to In progress...
Actions #3

Updated by Anonymous about 6 years ago

Est il possible de préciser pour quel type de publication on peut limiter la recherche pour la première version de l'API REST de recherche ?
Dans le développement qui est en cours je ne limitais pas le type de publication. Cela pourrait induire des simplifications sur le code.
Autre question, ce développement est il toujours maintenu sur la version 5.15-SNAPSHOT ou doit il être uniquement disponible sur le nouveau socle V6 ?
Cdlt

Actions #4

Updated by Nicolas Eysseric over 5 years ago

  • Target version set to Version 6
Actions #5

Updated by Nicolas Eysseric about 5 years ago

  • Subject changed from API Rest to Recherche : API Rest
Actions #6

Updated by Nicolas Eysseric about 5 years ago

  • Status changed from In progress... to Resolved
  • Assignee set to Nicolas Eysseric

Silverpeas dispose désormais d'une API Rest de recherche. Elle pourra tout de même être amenée à évoluer.

Un travail conséquent et indispensable a été nécessaire sur le code legacy afin de centraliser la recherche full-text et/ou taxonomique. Un service dédié à la recherche a été créé. L'objectif est de fournir un service simple qui fait abstraction des deux modes de recherche qui peuvent être complémentaires. Il s'appuie donc sur les modules existants silverpeas-core-pdc et sur la recherche full-text. Ce nouveau service est utilisé par l'UI de recherche de Silverpeas ainsi que par les applications Médiathèque et Annuaire d'experts. Cela a permis de supprimer de très nombreuses lignes de code (souvent dupliquées).

Ce nouveau service est également utilisé par le nouveau service REST de recherche.
Son URI est la suivante :

http://localhost:8000/silverpeas/services/search

Les paramètres possibles sont les suivants :
  • query : la chaîne recherchée (ex : projet)
  • spaceId : l'identifiant de l'espace sur laquelle la recherche est limitée (ex : WA12)
  • appId : l'identifiant de l'application sur laquelle la recherche est limitée (ex : kmelia50)
  • startDate : les résultats retournés sont créés après la date mentionnée
  • endDate : les résultats retournés sont créés avant la date mentionnée
  • taxonomyPosition : la position sur laquelle la recherche est limitée (ex : 8:/0/17/,9:/0/18/)

La requête retourne un tableau de résultat. Chaque résultat est constitué des données suivantes :

{componentId : "kmelia50" 
creationDate : "2016-09-29" 
description : "La description du résultat" 
id : "11220" 
name : "Outil #1" 
type : "Publication" 
updateDate : "2016-10-15"}

Pour l'heure, tous les résultats de la recherche sont retournés.

L'utilisation du plugin de recherche PDC a été généralisé. Désormais, c'est la seule façon de faire une recherche sur le PDC.
La page de recherche (utilisée en pied de page via le paramètre displayPDCFrame du look) a été modifiée afin d'utiliser le plugin.
Là encore, cela a permis de simplifier grandement le code tout en offrant une expérience utilisateur améliorée.

PR à valider et à intégrer :
Actions #7

Updated by Miguel Moquillon about 5 years ago

  • Status changed from Resolved to Integration in progress...
Actions #8

Updated by Miguel Moquillon about 5 years ago

  • Status changed from Integration in progress... to Closed
Actions

Also available in: Atom PDF