Les web services de l'Inist
FT2C-EZmaster | 2 years ago | ||
NLP_tools-EZmaster | 2 years ago | ||
affiliations-libpostal | 3 years ago | ||
affiliations-rnsr | 3 years ago | ||
affiliations-tools | 3 years ago | ||
ark-tools | 3 years ago | ||
base-line | 3 years ago | ||
biblio-tools | 2 years ago | ||
co-deduplicate | 2 years ago | ||
loterre-resolvers | 3 years ago | ||
loterre-xslt/ v1 | 3 years ago | ||
mapping-tools | 2 years ago | ||
nlp-tools2 | 2 years ago | ||
terms-extraction/v1/ teeft | 3 years ago | ||
www-home | 2 years ago | ||
.gitignore | 3 years ago | ||
.npmignore | 3 years ago | ||
.npmrc | 3 years ago | ||
CHANGELOG.md | 3 years ago | ||
Makefile | 2 years ago | ||
README.md | 2 years ago | ||
docker-compose.yml | 2 years ago | ||
package.json | 2 years ago |
Créer un web service en Python consiste à créer un script Python capable de traiter un fichier JSON fourni via l'entrée standard (sdtin) et de produire un fichier JSON similaire dans la sortie standard (stdout)
#!/usr/bin/python3 import sys import json for line in sys.stdin: data = json.loads(line) data['value'] = data['value'].upper() # YOUR STATEMENT HERE sys.stdout.write(json.dumps(data)) sys.stdout.write('\n')
Pour transformer un programme Python en web service, il est nécessaire de déclarer un point d’entrée (entrypoint) via la création d’un fichier .ini dans une arborescence spécifique (cf . Convention de nommage)
Ce fichier contiendra la documentation au foamt OpenAPI, et une référence au fichier python a exécuter.
# OpenAPI Documentation - JSON format (dot notation) post.responses.default.description = Return all objects with enrich fields post.responses.default.content.application/json.schema.$ref = #/components/schemas/JSONStream post.summary = Enrich one field of each Object with a Python function post.requestBody.required = true post.requestBody.content.application/json.schema.$ref = #/components/schemas/JSONStream post.parameters.0.in = query post.parameters.0.in = query post.parameters.0.name = indent post.parameters.0.schema.type = boolean post.parameters.0.description = Indent or not the JSON Result [use] plugin = @ezs/local plugin = @ezs/basics plugin = @ezs/storage plugin = @ezs/analytics [JSONParse] separator = * [expand] path = value size = 100 [expand/exec] # command should be executable ! # Use absolute path command = ./v1/strings/uppercase.py [dump] indent = env('indent', false)
L'installation de paquet Python spécifique est possible en déclarant les paquests à installer à la racine de son web service dans un ficher requirements.txt
spacy==2.3.5 pytextrank==2.0.1 pycld3 en-core-web-sm @ https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.3.1/en_core_web_sm-2.3.1.tar.gz fr-core-news-sm @ https://github.com/explosion/spacy-models/releases/download/fr_core_news_sm-2.3.0/fr_core_news_sm-2.3.0.tar.gz
Il est possible de tester localement (sur son poste) son webservice, dans un enviornement identique à celui de production, pour cela :
make python ./mon_repertoire
make nodejs ./base-line # ou cd base-line && ezs -v -d .
Ensuite, le webservice est accessible à cette adresse http://localhost:31976.
WARNING: Docker modifie le propiètaire des fichiers pour restaurer les permsisisons:
make reset
Des exemples de requêtes sont disponibles dans des fichers examples.http
. Ceux-ci peuvent être utilisés directement dans VSCode, avec l'extension REST Client (humao.rest-client). Ils peuvent également être lancés en ligne de commande via rest-cli ou via dot-http.
Exemple 1 : lancement des exemples sans affichage
$ restcli ./biblio-tools/examples.http examples:1 [1] POST https://biblio-tools.services.inist.fr/v1/unpaywall/is_oa?indent=true examples:2 [1] POST https://biblio-tools.services.inist.fr/v1/crossref/prefixes/expand?indent=true
Exemple 2 : lancement des exemples avec affichage
$ restcli --full ./affiliations-libpostal/examples.http examples:1 [1] POST https://affiliations-libpostal.services.inist.fr/v1/parse?indent=true POST https://affiliations-libpostal.services.inist.fr/v1/parse?indent=true Content-Type: application/json [ { "value": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238" } ] HTTP/1.1 200 OK Access-Control-Allow-Origin: * Connection: close Content-Disposition: inline Content-Encoding: gzip Content-Type: application/octet-stream Date: Fri, 23 Jul 2021 09:00:14 GMT Server: nginx/1.15.10 Transfer-Encoding: chunked [{ "value": { "id": "Barboncino 781 Franklin Ave, Crown Heights, Brooklyn, NY 11238", "value": { "house": "barboncino", "house_number": "781", "road": "franklin ave", "suburb": "crown heights", "city_district": "brooklyn", "state": "ny", "postcode": "11238" } } }]
Le répertoire www-home
contient le HTML de la page d'accueil https://services.inist.fr.
Si la racine de votre service répond une documentation respectant OpenAPI 3.0 (swagger), il vous suffit de la déclarer dans www-home/index.html
pour qu'elle soit prise en compte.
Chaque instance sur l'ezmaster de la machine aura un nom en trois parties:
La troisième partie du champ ne doit pas être communiquée à l'extérieur, c'est un numéro de version (si plusieurs instances ont les mêmes deux premiers champs, c'est la dernière version qui est exposée quand on n'utilise pas de numéro de version, ce qui sera le cas).
Le numéro de version permet la mise à jour de l'image docker associée au webservice.
Les champs textuels sont obligatoirement en minuscules, et sans accent (mais peuvent contenir des chiffres) et donc de préférence en anglais. Ils ne doivent pas contenir un nom de personne.
La première partie décrit le domaine d'application du webservice. Exemple : affiliation
, text
, classification
, nlp
, etc.
La seconde partie décrit une spécialité du domaine. Cette spécificité est principalement liée à une image docker différente, comme c'est le cas si les différents web services d'un domaine utilisent des langages différents (C++, python, nodejs, etc.)
Chaque instance donne accès à une arborescence de webservices. Le nom de route dépend du nom des répertoires. Les noms des répertoires doivent donc être choisis dans cette optique.
Il convient donc de respecter les pratiques communément admises dans la définition d'API de type REST. En utilisant des noms de répertoires en minuscules, sans accent (mais pouvant contenir des chiffres) et de préférence en anglais.
Si le premier niveau caractérise obligatoirement la version, les suivants peuvent être adaptés selon le besoin. On veillera à créer un répertoire si et seulement si il propose plusieurs sous-répertoire ou fichiers.
Exemples :
/v1/test/analyse
/v2/istex/expand
/v1/en/stemmer/analyse
Chaque répertoire dédié à une instance contiendra au moins un fichier examples.http
Ce fichier permet d'exécuter rapidement et simplement des exemples simples d'utilisation des webservices à travers VSCode ou restcli (en ligne de commande) Le format du fichier est celui précisé dans la documentation vscode https://github.com/Huachao/vscode-restclient#usage