Loading Dockerfile +2 −1 Original line number Diff line number Diff line ARG PHP_VERSION FROM registre.unicaen.fr:5000/unicaen-dev-php${PHP_VERSION}-apache #FROM registre.unicaen.fr:5000/unicaen-dev-php${PHP_VERSION}-apache FROM unicaen-dev-php${PHP_VERSION}-apache LABEL maintainer="Bertrand GAUTHIER <bertrand.gauthier at unicaen.fr>" Loading INSTALL.md +5 −5 Original line number Diff line number Diff line Loading @@ -6,7 +6,7 @@ Applicatif ### Première obtention des sources et installation du serveur *NB: la procédure proposée ici part d'un serveur *Debian Stretch* tout nu et couvre l'installation de tous les packages *NB: la procédure proposée ici part d'un serveur *Debian* tout nu et couvre l'installation de tous les packages requis.* Si ce n'était pas le cas, merci de le signaler. En `root` sur votre serveur, pour obtenir les sources du WS, lancez l'une des commandes suivantes en fonction Loading Loading @@ -50,8 +50,8 @@ NB: Vérifiez dans le script `Dockerfile.sh` que vous venez de lancer mais norma ### Installation d'une version précise du WS Normalement, vous ne devez installer que les versions officielles du WS, c'est à dire les versions taguées, du genre `2.1.0` par exemple. Normalement, vous ne devez installer que les versions officielles du WS, c'est à dire les versions taguées, du genre `2.3.0` par exemple. Si vous partez de zéro, choisissez bien-sûr la version la plus récente ! Placez-vous dans le répertoire des sources du web service puis lancez les commandes git suivantes pour obtenir la liste des versions officielles du WS : Loading @@ -59,10 +59,10 @@ versions officielles du WS : git fetch && git fetch --tags && git tag ``` Si la version la plus récente est par exemple la `2.1.0`, utilisez les commandes suivantes pour "installer" cette version Si la version la plus récente est par exemple la `2.3.0`, utilisez les commandes suivantes pour "installer" cette version sur votre serveur : ```bash git checkout --force 2.1.0 && bash install.sh git checkout --force 2.3.0 && bash install.sh ``` ### Fichier "users.htpasswd" Loading README.md +16 −13 Original line number Diff line number Diff line Loading @@ -13,25 +13,27 @@ Docker - Obtention de l'image de base Unicaen (construite) à jour ```bash PHP_VERSION=7.4 ; PHP_VERSION=8.0 \ docker pull registre.unicaen.fr:5000/unicaen-dev-php${PHP_VERSION}-apache ``` - Construction de l'image du web service ```bash PHP_VERSION=8.0 \ docker build \ --build-arg HTTP_PROXY \ --build-arg HTTPS_PROXY \ --build-arg NO_PROXY \ --build-arg PHP_VERSION \ -t sygal-import-ws-image-php${PHP_VERSION} . -t sygal-import-ws-image-php${PHP_VERSION} \ . ``` - Lancement du web service ```bash docker-compose up docker-compose up sygal-import-ws ``` Loading @@ -47,10 +49,10 @@ Lancement du web service *pour le dévelopement* Se placer à la racine des sources du ws pour lancer la commande suivante : ```bash docker-compose up --build docker-compose up --build sygal-import-ws ``` Vérifier que le container `sygal-import-ws-container` figure bien dans la liste des containers Vérifier que le container `sygal-import-ws-container-php8.0` figure bien dans la liste des containers lancés listés par la commande suivante (cf. colonne `NAMES`) : ```bash Loading Loading @@ -81,15 +83,16 @@ Chaque vue en base de données peut être interrogée via un service dédié : - `/titre-acces` - `/variable` Il y a aussi un service `/version` permettant de connaître le numéro de version du web service (ex : '1.3.7'). Il y a aussi un service `/version` () permettant de connaître le numéro de version du web service (ex : '2.3.0'). Versions -------- Versionning de l'API -------------------- L'API existe en plusieurs versions coexistantes, veillez à spécifier la version correcte dans l'URL. Prenez toujours la version la plus récente. L'API existe en plusieurs versions, veillez à spécifier la version correcte dans l'URL. Exemple pour la version 1 : `https://localhost:8443/v1/variable`. Exemple pour la version 2 : `https://localhost:8443/v2/variable`. Exemple de requête pour la version 2 : `https://localhost:8443/v2/version/latest`. Interrogation avec `curl` Loading Loading @@ -118,9 +121,9 @@ Afin d'obtenir les informations spécifiques à une donnée, il est possible d'a curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/v2/variable/ETB_LIB_NOM_RESP ``` Pour mettre en forme le JSON retourné et faciliter la lecture, une solution est d'utiliser `python -m json.tool`: Pour mettre en forme le JSON retourné et faciliter la lecture, une solution est d'utiliser `python`: ```bash curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/v2/variable | python -m json.tool curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/v2/variable | python3 -m json.tool ``` Loading composer.json +26 −20 Original line number Diff line number Diff line Loading @@ -3,6 +3,14 @@ "description": "Web service d'accès aux données des établissements pour nourrir SyGAL", "type": "project", "repositories": [ { "type": "vcs", "url": "https://github.com/orderadmin/api-tools-doctrine.git" }, { "type": "vcs", "url": "https://github.com/orderadmin/api-tools-doctrine-querybuilder.git" }, { "type": "composer", "url": "https://gest.unicaen.fr/packagist" Loading @@ -16,33 +24,31 @@ "laminas/laminas-dependency-plugin": true } }, "minimum-stability": "dev", "prefer-stable": true, "require": { "php": "^7.4.0", "doctrine/common": "^2.7", "doctrine/doctrine-orm-module": "^1.1", "laminas-api-tools/api-tools": "^1.3", "laminas-api-tools/api-tools-doctrine": "^2.1", "php": "^8.0", "doctrine/doctrine-orm-module": "^5.3", "laminas-api-tools/api-tools": "^1.6", "laminas-api-tools/api-tools-doctrine": "2.5.x-dev", "laminas-api-tools/api-tools-doctrine-querybuilder": "1.10.x-dev", "laminas-api-tools/api-tools-documentation": "^1.2", "laminas/laminas-console": "^2.7", "laminas/laminas-dependency-plugin": "^2.1", "laminas/laminas-development-mode": "^3.0", "laminas/laminas-component-installer": "^2.7", "laminas/laminas-log": "^2.9", "laminas/laminas-mvc-console": "^1.2", "laminas/laminas-mvc-i18n": "^1.7", "monolog/monolog": "^1.26", "unicaen/oracle": "^3.0", "webmozart/assert": "^1.9", "laminas/laminas-component-installer": "^2.7", "laminas/laminas-cache": "^2.7.1", "laminas/laminas-mvc-i18n": "^1.0" "unicaen/console": "^6.0", "unicaen/oracle": "dev-release_4.0.0", "webmozart/assert": "^1.9" }, "require-dev": { "laminas-api-tools/api-tools-admin": "^1.5", "laminas/laminas-developer-tools": "^1.1", "laminas/laminas-test": "^3.2", "phpunit/phpunit": "^6.5", "laminas/laminas-dependency-plugin": "^2.1", "laminas/laminas-development-mode": "^3.2", "laminas/laminas-developer-tools": "^2.3", "laminas/laminas-test": "^4.0", "phpunit/phpunit": "^8.0", "squizlabs/php_codesniffer": "^3.3", "zfcampus/zf-deploy": "^1.2", "laminas-api-tools/api-tools-asset-manager": "^1.0", "laminas-api-tools/api-tools-asset-manager": "^1.5", "laminas/laminas-composer-autoloading": "^2.0" }, "autoload": { Loading composer.lock +3897 −4147 File changed.Preview size limit exceeded, changes collapsed. Show changes Loading
Dockerfile +2 −1 Original line number Diff line number Diff line ARG PHP_VERSION FROM registre.unicaen.fr:5000/unicaen-dev-php${PHP_VERSION}-apache #FROM registre.unicaen.fr:5000/unicaen-dev-php${PHP_VERSION}-apache FROM unicaen-dev-php${PHP_VERSION}-apache LABEL maintainer="Bertrand GAUTHIER <bertrand.gauthier at unicaen.fr>" Loading
INSTALL.md +5 −5 Original line number Diff line number Diff line Loading @@ -6,7 +6,7 @@ Applicatif ### Première obtention des sources et installation du serveur *NB: la procédure proposée ici part d'un serveur *Debian Stretch* tout nu et couvre l'installation de tous les packages *NB: la procédure proposée ici part d'un serveur *Debian* tout nu et couvre l'installation de tous les packages requis.* Si ce n'était pas le cas, merci de le signaler. En `root` sur votre serveur, pour obtenir les sources du WS, lancez l'une des commandes suivantes en fonction Loading Loading @@ -50,8 +50,8 @@ NB: Vérifiez dans le script `Dockerfile.sh` que vous venez de lancer mais norma ### Installation d'une version précise du WS Normalement, vous ne devez installer que les versions officielles du WS, c'est à dire les versions taguées, du genre `2.1.0` par exemple. Normalement, vous ne devez installer que les versions officielles du WS, c'est à dire les versions taguées, du genre `2.3.0` par exemple. Si vous partez de zéro, choisissez bien-sûr la version la plus récente ! Placez-vous dans le répertoire des sources du web service puis lancez les commandes git suivantes pour obtenir la liste des versions officielles du WS : Loading @@ -59,10 +59,10 @@ versions officielles du WS : git fetch && git fetch --tags && git tag ``` Si la version la plus récente est par exemple la `2.1.0`, utilisez les commandes suivantes pour "installer" cette version Si la version la plus récente est par exemple la `2.3.0`, utilisez les commandes suivantes pour "installer" cette version sur votre serveur : ```bash git checkout --force 2.1.0 && bash install.sh git checkout --force 2.3.0 && bash install.sh ``` ### Fichier "users.htpasswd" Loading
README.md +16 −13 Original line number Diff line number Diff line Loading @@ -13,25 +13,27 @@ Docker - Obtention de l'image de base Unicaen (construite) à jour ```bash PHP_VERSION=7.4 ; PHP_VERSION=8.0 \ docker pull registre.unicaen.fr:5000/unicaen-dev-php${PHP_VERSION}-apache ``` - Construction de l'image du web service ```bash PHP_VERSION=8.0 \ docker build \ --build-arg HTTP_PROXY \ --build-arg HTTPS_PROXY \ --build-arg NO_PROXY \ --build-arg PHP_VERSION \ -t sygal-import-ws-image-php${PHP_VERSION} . -t sygal-import-ws-image-php${PHP_VERSION} \ . ``` - Lancement du web service ```bash docker-compose up docker-compose up sygal-import-ws ``` Loading @@ -47,10 +49,10 @@ Lancement du web service *pour le dévelopement* Se placer à la racine des sources du ws pour lancer la commande suivante : ```bash docker-compose up --build docker-compose up --build sygal-import-ws ``` Vérifier que le container `sygal-import-ws-container` figure bien dans la liste des containers Vérifier que le container `sygal-import-ws-container-php8.0` figure bien dans la liste des containers lancés listés par la commande suivante (cf. colonne `NAMES`) : ```bash Loading Loading @@ -81,15 +83,16 @@ Chaque vue en base de données peut être interrogée via un service dédié : - `/titre-acces` - `/variable` Il y a aussi un service `/version` permettant de connaître le numéro de version du web service (ex : '1.3.7'). Il y a aussi un service `/version` () permettant de connaître le numéro de version du web service (ex : '2.3.0'). Versions -------- Versionning de l'API -------------------- L'API existe en plusieurs versions coexistantes, veillez à spécifier la version correcte dans l'URL. Prenez toujours la version la plus récente. L'API existe en plusieurs versions, veillez à spécifier la version correcte dans l'URL. Exemple pour la version 1 : `https://localhost:8443/v1/variable`. Exemple pour la version 2 : `https://localhost:8443/v2/variable`. Exemple de requête pour la version 2 : `https://localhost:8443/v2/version/latest`. Interrogation avec `curl` Loading Loading @@ -118,9 +121,9 @@ Afin d'obtenir les informations spécifiques à une donnée, il est possible d'a curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/v2/variable/ETB_LIB_NOM_RESP ``` Pour mettre en forme le JSON retourné et faciliter la lecture, une solution est d'utiliser `python -m json.tool`: Pour mettre en forme le JSON retourné et faciliter la lecture, une solution est d'utiliser `python`: ```bash curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/v2/variable | python -m json.tool curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/v2/variable | python3 -m json.tool ``` Loading
composer.json +26 −20 Original line number Diff line number Diff line Loading @@ -3,6 +3,14 @@ "description": "Web service d'accès aux données des établissements pour nourrir SyGAL", "type": "project", "repositories": [ { "type": "vcs", "url": "https://github.com/orderadmin/api-tools-doctrine.git" }, { "type": "vcs", "url": "https://github.com/orderadmin/api-tools-doctrine-querybuilder.git" }, { "type": "composer", "url": "https://gest.unicaen.fr/packagist" Loading @@ -16,33 +24,31 @@ "laminas/laminas-dependency-plugin": true } }, "minimum-stability": "dev", "prefer-stable": true, "require": { "php": "^7.4.0", "doctrine/common": "^2.7", "doctrine/doctrine-orm-module": "^1.1", "laminas-api-tools/api-tools": "^1.3", "laminas-api-tools/api-tools-doctrine": "^2.1", "php": "^8.0", "doctrine/doctrine-orm-module": "^5.3", "laminas-api-tools/api-tools": "^1.6", "laminas-api-tools/api-tools-doctrine": "2.5.x-dev", "laminas-api-tools/api-tools-doctrine-querybuilder": "1.10.x-dev", "laminas-api-tools/api-tools-documentation": "^1.2", "laminas/laminas-console": "^2.7", "laminas/laminas-dependency-plugin": "^2.1", "laminas/laminas-development-mode": "^3.0", "laminas/laminas-component-installer": "^2.7", "laminas/laminas-log": "^2.9", "laminas/laminas-mvc-console": "^1.2", "laminas/laminas-mvc-i18n": "^1.7", "monolog/monolog": "^1.26", "unicaen/oracle": "^3.0", "webmozart/assert": "^1.9", "laminas/laminas-component-installer": "^2.7", "laminas/laminas-cache": "^2.7.1", "laminas/laminas-mvc-i18n": "^1.0" "unicaen/console": "^6.0", "unicaen/oracle": "dev-release_4.0.0", "webmozart/assert": "^1.9" }, "require-dev": { "laminas-api-tools/api-tools-admin": "^1.5", "laminas/laminas-developer-tools": "^1.1", "laminas/laminas-test": "^3.2", "phpunit/phpunit": "^6.5", "laminas/laminas-dependency-plugin": "^2.1", "laminas/laminas-development-mode": "^3.2", "laminas/laminas-developer-tools": "^2.3", "laminas/laminas-test": "^4.0", "phpunit/phpunit": "^8.0", "squizlabs/php_codesniffer": "^3.3", "zfcampus/zf-deploy": "^1.2", "laminas-api-tools/api-tools-asset-manager": "^1.0", "laminas-api-tools/api-tools-asset-manager": "^1.5", "laminas/laminas-composer-autoloading": "^2.0" }, "autoload": { Loading