Skip to content

Commit

Permalink
[Documentazione]
Browse files Browse the repository at this point in the history
Rivista sezione 'how to' dei manuali.
  • Loading branch information
andreapoli committed Oct 7, 2019
1 parent 5b2a258 commit f0d13b4
Show file tree
Hide file tree
Showing 52 changed files with 567 additions and 586 deletions.
2 changes: 1 addition & 1 deletion resources/doc/src/manuali/howto/Govway_draw.io.xml

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions resources/doc/src/manuali/howto/avanzate/cors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In GovWay è abilitata per default una gestione globale del CORS. I
dettagli sulla configurazione globale sono accedibili tramite la voce
del menù *'Configurazione - Generale'* all'interno della sezione
*'Gestione CORS'*. Per il dettaglio sul significa di ogni voce si
rimanda alla specifica CORS *https://www.w3.org/TR/cors/*. Sono
rimanda alla specifica CORS (https://www.w3.org/TR/cors/). Sono
abilitati per default:

- *Access-Control-Allow-Origins*: Qualsiasi origine (\*)
Expand Down Expand Up @@ -78,7 +78,7 @@ parametri per utilizzare il servizio descritto nella sezione :ref:`erogazioneRES
"status": "available"
}

- *Remote URL*: http://127.0.0.1:8080/govway/Ente/PetStore/v2/pet
- *Remote URL*: http://127.0.0.1:8080/govway/Ente/PetStore/v1/pet

Se si attiva la modalità *Developers Tool* (es. su Chrome 'More Tools -
Developers Tool') è possibile vedere le richieste effettuate dal browser
Expand Down
190 changes: 102 additions & 88 deletions resources/doc/src/manuali/howto/avanzate/gruppi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,20 @@ utilizzando la console *govwayConsole*, procedere come segue:
1. **Registrazione Gruppo 'Creazione e Modifica'**

Accedere alla sezione *'Erogazioni'* e selezionare l'API
precedentemente registrata *'PetStore v2'*. Dopodichè accedere, dal
dettaglio dell'erogazione, alla sezione *'Gruppi'* dove vengono
visualizzati i gruppi in cui sono state classificate le risorse. Per
default è presente un solo gruppo *Predefinito* a cui sono associate
tutte le risorse (:numref:`quick_gruppiRisorseIniziale_fig`).
precedentemente registrata *'PetStore v1'*. Dopodichè accedere, dal
dettaglio dell'erogazione, alla sezione di configurazione dell'API cliccando sul pulsante *Configura* posto in basso a destra.
La successiva maschera consente di configurare l'API e di visualizzare
i gruppi in cui sono state classificate le risorse. Per
default non è presente alcun raggruppamento (:numref:`quick_gruppiRisorseIniziale_fig`).

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoPredefinito.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseIniziale_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoPredefinito.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseIniziale_fig

Situazione iniziale con unico gruppo 'Predefinito'
Situazione iniziale con unico gruppo 'Predefinito'

Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
Selezionare il pulsante *'Crea Nuova'* e fornire i seguenti dati:

- *Nome Gruppo*: permette di associare un nome al gruppo delle
risorse. Per il nostro esempio utilizzare il nome 'Creazione e
Expand All @@ -79,16 +79,43 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
ex-novo. Per riprodurre lo scenario di esempio precedentemente
descritto selezionare *Nuova*.

- *Autenticazione - Stato*: per esporre l'API in modo che sia
invocabile da client identificati tramite credenziali http-basic
selezionare lo stato *'http basic'*.
- *Controllo degli Accessi - Accesso API*: per esporre l'API in modo che sia
invocabil da client identificati tramite credenziali selezionare lo
stato *'autenticato'*.

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoCreazioneModifica.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseCreazione_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoCreazioneModifica.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseCreazione_fig

Registrazione Gruppo 'Creazione e Modifica'

Terminata la creazione, l'accesso alle risorse del gruppo 'Creazione e Modifica', richiede che il client presenti delle credenziali ssl come indicato nella sezione :ref:`authHTTPS_mittenti` ( :numref:`quick_gruppiRisorseCreazione_step2_fig` ).

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoCreazioneModifica_step2.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseCreazione_step2_fig

Gruppo 'Creazione e Modifica' configurato con autenticazione 'https'

Registrazione Gruppo 'Creazione e Modifica'
Per impostare una autenticazione 'http-basic' accedere in modifica alla configurazione del Controllo degli Accessi indicando un'autenticazione 'http-basic' e disabilitando l'autorizzazione come mostrato nella figura :numref:`quick_gruppiRisorseCreazione_step3_fig`.

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoCreazioneModifica_step3.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseCreazione_step3_fig

Gruppo 'Creazione e Modifica', Controllo degli Accessi configurazione con autenticazione 'http-basic'

Una volta salvata la nuova configurazione per il Controllo degli Accessi, per accedere alle risorse associate al gruppo 'Creazione e Modifiche' un client deve presentare delle credenziali http-basic ( :numref:`quick_gruppiRisorseCreazione_step4_fig` ) associate ad un soggetto o un applicativo registrato su GovWay. Al punto 7. verrà descritto come registrare un soggetto che possiede delle credenziali http-basic valide utilizzate in questo scenario di test.

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoCreazioneModifica_step4.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseCreazione_step4_fig

Gruppo 'Creazione e Modifica', Controllo degli Accessi configurato con autenticazione 'http-basic'

2. **Registrazione Gruppo 'Eliminazione'**

Expand All @@ -102,46 +129,37 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
- *Modalità*: Per riprodurre lo scenario di esempio precedentemente
descritto selezionare *Nuova*.

- *Autenticazione - Stato*: selezionare lo stato *'https'*.
- *Controllo degli Accessi - Accesso API*: per esporre l'API in modo che sia
invocabil da client identificati tramite credenziali selezionare lo
stato *'autenticato'*.

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoEliminazione.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseEliminazione_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoEliminazione.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseEliminazione_fig

Registrazione Gruppo 'Eliminazione'

Registrazione Gruppo 'Eliminazione'
Come descritto precedentemente per il gruppo 'Creazione e Modifica' modificare la configurazione relativa al Controllo degli Accessi per impostare un'autenticazione 'http-basic'.

3. **Verifica Gruppi Esistenti**

Dal dettaglio dell'erogazione, accedere alla sezione *'Gruppi
Risorse'* dove adesso verranno visualizzati tre gruppi, i due gruppi
Dal dettaglio dell'erogazione, accedendo alla sezione di configurazione dell'API cliccando sul pulsante *Configura* posto in basso a destra, è possibile visualizzati tre gruppi, i due gruppi
creati in precedenza ed il gruppo predefinito che adesso contiene
solamente le risorse con metodo http GET (:numref:`quick_gruppiRisorseRegistrati_fig`). In questa
sezione sarà possibile agire sui gruppi anche in un secondo momento
aggiungendo o eliminando risorse da un gruppo o creandone di nuovi.
solamente le risorse con metodo http GET (:numref:`quick_gruppiRisorseRegistrati_fig`).

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoPredefinitoVerifica.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseRegistrati_fig

Gruppi Registrati

#. Sempre dal dettaglio dell'erogazione, accedere alla sezione
*'Configurazione'* dove vengono visualizzati i tre gruppi. In questa
sezione sarà possibile configurare per ogni gruppo le funzionalità
descritte nelle successive sezioni della guida. Si
può notare come i due gruppi creati per l'esempio possiedano un
*Controllo Accessi* abilitato, mentre il gruppo *Predefinito* che
contiene solo le risorse GET possiede tale funzionalità disabilitata.
(:numref:`quick_gruppiRisorseConfig_fig`).
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoPredefinitoVerifica.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseRegistrati_fig

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoPredefinitoVerifica2.png
:scale: 100%
:align: center
:name: quick_gruppiRisorseConfig_fig
Gruppi Registrati

Configurazioni dei Gruppi
Nella sezione di configurazione sarà possibile agire sui gruppi anche in un secondo momento
aggiungendo o eliminando risorse da un gruppo o creandone di nuovi. Inoltre sarà possibile configurare per ogni gruppo le funzionalità
disponibili con Govway quali Validazione dei Contenuti, Rate Limiting, Trasformazioni etc...

Si può notare come i due gruppi creati per l'esempio possiedano un *Controllo Accessi* abilitato ( :numref:`quick_gruppiRisorseCreazione_step4_fig` ), mentre il gruppo *Predefinito* che contiene solo le risorse GET possiede tale funzionalità disabilitata ( :numref:`quick_gruppiRisorseRegistrati_fig` ).

4. **Reset Cache delle Configurazioni di GovWay**

Expand All @@ -153,22 +171,21 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
sezione *'Strumenti' - 'Runtime'* e selezionare la voce
*'ResetAllCaches'*. (:numref:`quick_gruppiResetCache_fig`).

.. figure:: ../_figure_howto/resetCache.png
:scale: 100%
:align: center
:name: quick_gruppiResetCache_fig
.. figure:: ../_figure_howto/resetCache.png
:scale: 100%
:align: center
:name: quick_gruppiResetCache_fig

Reset Cache delle Configurazioni di GovWay
Reset Cache delle Configurazioni di GovWay

5. **Invocazione Anonima di una Risorsa del gruppo 'Predefinito'
completata con successo**
5. **Invocazione Anonima di una Risorsa del gruppo 'Predefinito' completata con successo**

Effettuando una richiesta di un animale tramite http method *GET* si
può vedere come la richiesta completa con successo:

::

curl -v -X GET "http://127.0.0.1:8080/govway/Ente/PetStore/v2/pet/1" \
curl -v -X GET "http://127.0.0.1:8080/govway/Ente/PetStore/v1/pet/1" \
-H "accept: application/json"

L'esito dell'aggiornamento viene confermato con un codice http 200 e
Expand All @@ -195,16 +212,15 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
status":"available"
}

6. **Invocazione Anonima di una Risorsa del gruppo 'Creazione e
Modifica' terminata con errore**
6. **Invocazione Anonima di una Risorsa del gruppo 'Creazione e Modifica' terminata con errore**

Effettuando una modifica di un animale tramite http method *PUT* si
può vedere come la richiesta termina con errore causato dal fatto che
non si sono fornite credenziali *http basic*:

::

curl -v -X PUT "http://127.0.0.1:8080/govway/Ente/PetStore/v2/pet" \
curl -v -X PUT "http://127.0.0.1:8080/govway/Ente/PetStore/v1/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d '{
Expand Down Expand Up @@ -248,22 +264,21 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
diagnostici emessi da GovWay nei quali viene evidenziato il motivo
del fallimento (:numref:`quick_invocazioneBloccata_fig`).

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoConsultazioneStoricoTransazioni.png
:scale: 100%
:align: center
:name: quick_tracceGW_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoConsultazioneStoricoTransazioni.png
:scale: 100%
:align: center
:name: quick_tracceGW_fig

Tracce delle invocazioni transitate sul Gateway
Tracce delle invocazioni transitate sul Gateway

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoConsultazioneStoricoTransazioniDettaglio.png
:scale: 100%
:align: center
:name: quick_invocazioneBloccata_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoConsultazioneStoricoTransazioniDettaglio.png
:scale: 100%
:align: center
:name: quick_invocazioneBloccata_fig

Dettaglio di una invocazione fallita bloccata dal Gateway
Dettaglio di una invocazione fallita bloccata dal Gateway

7. **Invocazione di una Risorsa del gruppo 'Creazione e Modifica' con
credenziali 'http basic' completata con successo**
7. **Invocazione di una Risorsa del gruppo 'Creazione e Modifica' con credenziali 'http basic' completata con successo**

Per verificare che l'invocazione http descritta al punto precedente
termini con successo in presenza di credenziali http basic si deve
Expand All @@ -276,14 +291,14 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
*'http basic'* come ad esempio un username *enteEsterno* ed una
password *123456* (:numref:`quick_gruppoEliminazione_fig`).

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoSoggettoAssociazioneCredenziale.png
:scale: 100%
:align: center
:name: quick_gruppoEliminazione_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoSoggettoAssociazioneCredenziale.png
:scale: 100%
:align: center
:name: quick_gruppoEliminazione_fig

Registrazione Gruppo 'Eliminazione'
Registrazione Gruppo 'Eliminazione'

#. Dopo aver associato le credenziali al soggetto effettuare il reset
Dopo aver associato le credenziali al soggetto effettuare il reset
della cache delle configurazioni del Gateway come descritto in
precedenza prima di procere con l'invocazione.

Expand All @@ -293,7 +308,7 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:

::

curl -v -X PUT "http://127.0.0.1:8080/govway/Ente/PetStore/v2/pet" --basic --user enteEsterno:123456 \
curl -v -X PUT "http://127.0.0.1:8080/govway/Ente/PetStore/v1/pet" --basic --user enteEsterno:123456 \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d '{
Expand Down Expand Up @@ -329,16 +344,15 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
"status":"available"
}

8. **Invocazione di una Risorsa del gruppo 'Eliminazione' con
credenziali 'http basic' terminata con errore**
8. **Invocazione di una Risorsa del gruppo 'Eliminazione' con credenziali 'http basic' terminata con errore**

Effettuando una eliminazione di un animale tramite http method *DEL*
si può vedere come la richiesta termina con errore causato dal fatto
che non si sono fornite credenziali *https*:

::

curl -v -X DELETE "http://127.0.0.1:8080/govway/Ente/PetStore/v2/pet/545646489" --basic --user enteEsterno:123456 \
curl -v -X DELETE "http://127.0.0.1:8080/govway/Ente/PetStore/v1/pet/545646489" --basic --user enteEsterno:123456 \
-H "accept: application/json"

L'esito dell'eliminazione termina con un codice http 401 e una
Expand Down Expand Up @@ -369,12 +383,12 @@ Selezionare il pulsante *'Aggiungi'* e fornire i seguenti dati:
:numref:`quick_tracceInvocazioni_fig` si può vedere come le transazioni con metodo http *DEL* sono
terminate con errore con esito *Autenticazione Fallita*.

.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoConsultazioneStoricoTransazioni2.png
:scale: 100%
:align: center
:name: quick_tracceInvocazioni_fig
.. figure:: ../_figure_howto/gruppiRisorseRESTBaseGruppoConsultazioneStoricoTransazioni2.png
:scale: 100%
:align: center
:name: quick_tracceInvocazioni_fig

Tracce delle invocazioni transitate sul Gateway
Tracce delle invocazioni transitate sul Gateway

.. note:: **Ripristino Erogazione API con il solo gruppo predefinito per prosieguo degli scenari**
|br|
Expand Down
2 changes: 1 addition & 1 deletion resources/doc/src/manuali/howto/avanzate/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Raccolta di esempi relativi alle funzionalità avanzate.
:maxdepth: 2

multiTenant
gruppi
cors
sospensione
gruppi
Loading

0 comments on commit f0d13b4

Please sign in to comment.