diff --git a/README.md b/README.md index 34aad94..73f5d58 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,24 @@ # Les web services TDM de l'Inist -### Tester +## Tester -Des exemples de requetes sont disponbiles dans des fichers `examples.http` -ceux-ci peuvent être utilisés directment dans VSCode, avec l'extension REST Client (humao.rest-client) +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](https://www.npmjs.com/package/rest-cli) -ou via [dot-http](https://github.com/bayne/dot-http) +ou via [dot-http](https://github.com/bayne/dot-http). Exemple 1 : lancement des exemples sans affichage ```bash - $ 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 ```bash - - $ 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 @@ -58,26 +54,22 @@ } } }] -$ ``` -### Développement en local +## Développement en local - -- Pour les services utilisant lodex-workers : +- Pour les services utilisant [lodex-workers](https://github.com/Inist-CNRS/lodex-workers) : Lancement du serveur local ```bash -$ cd loterre-resolvers -$ ezs -v -d . +cd loterre-resolvers +ezs -v -d . ``` -le webservice est accessible à cette adresse http://localhost:31976 +le webservice est accessible à cette adresse . - - -### Déclarer la documentation Swagger +## Déclarer la documentation Swagger Le répertoire `www-home` contient le HTML de la page d'accueil . @@ -108,25 +100,25 @@ 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. +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. +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 +c'est le cas si les différents *web services* d'un domaine utilisent des langages différents (C++, python, nodejs, etc.) ### Nom des répertoires -Chaque instance donne accès à une arborescence de webservices. -Le nom de route dépend du nom des répertoires. +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. +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. +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. 1. Version des APIs (v1, v2, v3, etc.) @@ -134,8 +126,8 @@ 3. Nom de l'action ou de l'algorithme caractérisant le traitement 4. (...) -Exemple : +Exemples : -- /v1/test/analyse -- /v2/istex/expand -- /v1/en/stemmer/analyse +- `/v1/test/analyse` +- `/v2/istex/expand` +- `/v1/en/stemmer/analyse`