Commit 3a56935e authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Merge branch 'release_3.0.0' into test

parents 4d40330c 3869a78d

doc/apigility.md

deleted100644 → 0
+0 −40
Original line number Diff line number Diff line 
Utiliser l'interface d'admin Apigility

======================================

    

Ouvrir l'interface d'admin

--------------------------

    

- Lancer si besoin le web service dans Docker :

  `docker-compose up sygal-import-ws`  



- Passer en mode développement :

  `docker-compose exec sygal-import-ws vendor/bin/zf-development-mode enable`   

  

- Ouvrir l'interface d'admin dans un navigateur, exemple :

  `https://localhost:8443`

  

  NB: le numéro de port dépend de la config `docker-compose.yml`, faites un `docker ps` pour le connaître.

  

- Autoriser l'interface d'admin à écrire dans les fichiers de config

  du web service :

  `docker-compose exec sygal-import-ws chown -R www-data:www-data module/ImportData/config` 



Modification de l'API

---------------------



- Le cas échéant, faire les modifications nécessaires sur l'API.



Fermer l'interface d'admin

--------------------------



- Rétablir les autorisations d'accès au fichiers :

  `sudo chown -R ${USER}:${USER} module/ImportData/config` 

  

- Ne pas oublier de désactiver le mode développement :

  `docker-compose exec sygal-import-ws vendor/bin/zf-development-mode disable`



Test

----



- Interroger l'API pour vérifier les modifs, exemple :

`curl --insecure --header "Accept: application/json" --header "Authorization: Basic c3lnYWwtYXBwOmF6ZXJ0eQ==" https://localhost:8443/doctorant`

module/ImportData/src/V1/Query/Provider/FetchAll.php

+1 −8
Original line number Diff line number Diff line
@@ -8,15 +8,8 @@ use Laminas\ApiTools\Rest\ResourceEvent; 


class FetchAll extends DefaultOrm

{

    /**

     * @param ResourceEvent $event

     * @param string        $entityClass

     * @param array         $parameters

     * @return QueryBuilder

     */

    public function createQuery(ResourceEvent $event, $entityClass, $parameters)

    public function createQuery(ResourceEvent $event, $entityClass, $parameters): QueryBuilder

    {

        /** @var QueryBuilder $qb */

        $qb = parent::createQuery($event, $entityClass, $parameters);



        $qb->orderBy('row.id', 'asc'); // indispensable car les données sont demandées paginées

module/ImportData/src/V1/Rest/Acteur/ActeurFetchAll.php

+1 −7
Original line number Diff line number Diff line
@@ -8,13 +8,7 @@ use Laminas\ApiTools\Rest\ResourceEvent; 


class ActeurFetchAll extends FetchAll

{

    /**

     * @param ResourceEvent $event

     * @param string        $entityClass

     * @param array         $parameters

     * @return QueryBuilder

     */

    public function createQuery(ResourceEvent $event, $entityClass, $parameters)

    public function createQuery(ResourceEvent $event, $entityClass, $parameters): QueryBuilder

    {

        $qb = parent::createQuery($event, $entityClass, $parameters);

module/ImportData/src/V2/Query/Provider/FetchAll.php

+1 −8
Original line number Diff line number Diff line
@@ -8,15 +8,8 @@ use Laminas\ApiTools\Rest\ResourceEvent; 


class FetchAll extends DefaultOrm

{

    /**

     * @param ResourceEvent $event

     * @param string        $entityClass

     * @param array         $parameters

     * @return QueryBuilder

     */

    public function createQuery(ResourceEvent $event, $entityClass, $parameters)

    public function createQuery(ResourceEvent $event, $entityClass, $parameters): QueryBuilder

    {

        /** @var QueryBuilder $qb */

        $qb = parent::createQuery($event, $entityClass, $parameters);



        $qb->orderBy('row.id', 'asc'); // indispensable car les données sont demandées paginées

module/ImportData/src/V2/Rest/Acteur/ActeurFetchAll.php

+1 −7
Original line number Diff line number Diff line
@@ -8,13 +8,7 @@ use Laminas\ApiTools\Rest\ResourceEvent; 


class ActeurFetchAll extends FetchAll

{

    /**

     * @param ResourceEvent $event

     * @param string        $entityClass

     * @param array         $parameters

     * @return QueryBuilder

     */

    public function createQuery(ResourceEvent $event, $entityClass, $parameters)

    public function createQuery(ResourceEvent $event, $entityClass, $parameters): QueryBuilder

    {

        $qb = parent::createQuery($event, $entityClass, $parameters);