diff --git a/README.md b/README.md index 61b4a36..9530021 100644 --- a/README.md +++ b/README.md @@ -130,14 +130,16 @@ ## Tester 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). +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). Exemple 1 : lancement des exemples sans affichage ```bash -$ restcli ./biblio-tools/examples.http +$ npx 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 ``` @@ -145,7 +147,7 @@ Exemple 2 : lancement des exemples avec affichage ```bash -$ restcli --full ./affiliations-libpostal/examples.http +$ npx 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 @@ -204,7 +206,7 @@ #### Tags -Si vous souhaitez enrichir la documentation par défaut, en ajoutant des _tags_, +Si vous souhaitez enrichir la documentation par défaut, en ajoutant des *tags*, des components, il est possible d'ajouter un fichier standard `swagger.json` à la racine de votre instance. Le serveur prendra en compte tout le fichier SAUF ce qui correspond aux @@ -247,7 +249,7 @@ > éviter que le script ne fasse abstraction du tableau (auquel cas il faudrait > l'ajouter à la main dans les exemples). > -> **Note 3**: vous pouvez _nommer_ les exemples, en ajoutant `# @name +> **Note 3**: vous pouvez *nommer* les exemples, en ajoutant `# @name > identifiant` sur une ligne avant la requête (en remplaçant identifiant par une > valeur unique). > Ainsi vous pouvez appeler la commande `make example-metadata terms-extraction @@ -258,9 +260,13 @@ Le répertoire `www-home` contient le HTML de la page de documentation OpenAPI . -Pour ajouter une instance dans le menu déroulant (en haut à droite), il vous +Obsolète: ~~Pour ajouter une instance dans le menu déroulant (en haut à droite), il vous suffit de la déclarer dans `www-home/index.html` pour qu'elle soit prise en -compte. +compte.~~ + +Cela se fait maintenant automatiquement au `make publish` (mais il faut avoir +les accès à la machine `daf` pour ça). +Voir [Publication d'une instance](#publication-dune-instance). ## Convention de nommage @@ -289,7 +295,7 @@ 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 @@ -329,8 +335,8 @@ ### Fichier de test -Dans la plupart des cas, on peut générer un fichier `tests.hurl` à partir d'un -fichier `examples.http`. +Quand l'instance est déployée et publiée, on peut générer un fichier +`tests.hurl` à partir d'un fichier `examples.http`. Il y a une commande `make generate-example-tests address-kit`. Pour lancer le fichier, à condition d'avoir installé les paquets npm: @@ -349,10 +355,10 @@ ## Créer une version Afin de faciliter le déploiement (et de le limiter à un répertoire), on peut -utiliser les _helpers_ du Makefile (`make version-major`, `make version-minor`, +utiliser les *helpers* du Makefile (`make version-major`, `make version-minor`, `make version-patch`). -Ils se chargent de mettre un _tag_ git sur répertoire et de le pousser sur le dépôt. +Ils se chargent de mettre un *tag* git sur répertoire et de le pousser sur le dépôt. Leur seul paramètre est le nom du répertoire. Exemple: