Gestione delle risorse

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Nota: negli ambienti abilitati per i deployment di archiviazione, non puoi gestire le risorse utilizzando la UI, l'API o gcloud di Apigee. Per gestire le risorse per i deployment di archiviazione utilizzando Apigee in VS Code, consulta Gestione delle risorse.

Comprendi e gestisci le risorse, come descritto nelle sezioni seguenti.

Informazioni sulle risorse

Molti tipi di criteri si basano sulle risorse. Le risorse sono i file che implementano il codice o la configurazione che deve essere eseguita da un criterio quando è collegato a un proxy API. In alcuni casi, come con JavaScript e JavaCallout, un criterio definisce semplicemente un punto di collegamento in un proxy API in cui deve essere eseguito del codice. Il criterio JavaScript o JavaCallout è un puntatore a una risorsa.

Tipi di risorse

La tabella seguente riassume i tipi di risorse:

Tipo di risorsa	Descrizione
GraphQL (graphql)	File di schema GraphQL a cui fanno riferimento i criteri di GraphQL.
JAR (java)	classi Java in un file JAR a cui fanno riferimento i criteri di JavaCallout.
JavaScript (js)	JavaScript a cui fanno riferimento le norme relative a JavaScript.
JavaScript (jsc)	JavaScript compilato a cui si fa riferimento nelle norme di JavaScript.
OpenAPI Specification (oas)	La specifica OpenAPI utilizzata per convalidare i messaggi di richiesta e risposta di tipo JSON o YAML.
Property Set (properties)	Raccolta di coppie chiave-valore a cui fare riferimento in set di proprietà proxy API.
Python (py)	Script Python a cui fanno riferimento i criteri PythonScript. Le risorse devono essere implementate in "Python puro" (solo nel linguaggio Python).
Security policy (securityPolicy)	Criterio di sicurezza personalizzato a cui fanno riferimento i criteri di JavaCallout.
WSDL (wsdl)	File WSDL a cui fanno riferimento i criteri SOAPMessageValidation.
XSD (xsd)	Schemi XML a cui fanno riferimento i criteri di SOAPMessageValidation.
XSL Transformations (xsl)	Trasformazioni shard a cui fanno riferimento i criteri di XSLTransform.

Dove sono archiviate le risorse

Puoi archiviare le risorse nelle seguenti località. Non puoi archiviare file di risorse in un'organizzazione.

• Revisione proxy API: le risorse sono disponibili solo per le revisioni del proxy API in cui sono incluse. Ad esempio, puoi includere una risorsa JavaScript con la revisione 1 di un proxy API, quindi modificare l'implementazione in modo da utilizzare uno script Python nella revisione 2 del proxy. La revisione 1 ha accesso solo alla risorsa JavaScript, mentre la revisione 2 ha accesso solo alla risorsa Python.
  Nota: nell'interfaccia utente, le risorse con ambito di una revisione del proxy API sono elencate nella sezione Risorse del riquadro di navigazione, indipendentemente dal fatto che tu le abbia aggiunte con l'interfaccia utente o l'API.
• Ambiente: se archiviate in un ambiente (ad esempio test o prod), le risorse sono disponibili per qualsiasi proxy API di cui è stato eseguito il deployment nello stesso ambiente.

Il repository di ambiente è disponibile al seguente URI, come descritto dall'API List resource files e successivamente in Gestire le risorse con l'API: /organizations/$ORG/environments/$ENV/resourcefiles

Nota: non puoi visualizzare il repository delle risorse di revisione del proxy API utilizzando l'API.

La seguente tabella mostra i metodi che puoi utilizzare per creare, aggiornare ed eliminare le risorse per ogni repository:

Repository	Crea		Visualizza		Aggiorna		Elimina
	API	UI	API	UI	API	UI	API	UI
Revisione proxy API
Ambiente

Ad esempio, tutti i file JavaScript disponibili per l'ambiente test sono archiviati nel seguente repository e sono disponibili per qualsiasi proxy API in esecuzione nell'ambiente test:

/organizations/$ORG/environments/test/resourcefiles/jsc

Risoluzione dei nomi delle risorse

Risolvi i nomi delle risorse dall'ambito più specifico a quello più generale. I nomi delle risorse vengono risolti "più avanti nella catena", dal livello di revisione del proxy API al livello di ambiente.

Supponiamo che tu abbia completato la stessa risorsa in due repository diversi: la revisione del proxy API e l'ambiente prod.

Considera il proxy API configurato con il seguente criterio:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Il riferimento ai criteri non può essere risolto esplicitamente in un repository. La prima risorsa nell'ambito più granulare il cui nome corrisponde a quello nel criterio viene risolta.

Quindi, quando viene eseguito il deployment del proxy API nell'ambiente prod, il criterio verrà risolto nella risorsa pathSetter.js con ambito ambiente.

Una volta eseguito il deployment nell'ambiente test, il criterio verrà risolto nella risorsa con ambito di revisione del proxy API, perché la risorsa con ambito di ambiente si trova nell'ambiente prod, non nell'ambiente test.

Linee guida per le risorse Java

Puoi aggiungere risorse Java compilate come file JAR utilizzando diverse opzioni in curl, ad esempio -T, --data-binary o -F (non l'opzione -d). Ad esempio:

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @{jar_file}

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  -T "{jar_file}"

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  -F "file=@{jar_file}"

Nota: nome dei pacchetti: non utilizzare io.apigee o com.apigee come nomi dei pacchetti nei callout Java. Questi sono riservati e utilizzati da altri moduli Apigee.

Vedi anche:

• Best practice Java: best practice per la progettazione e lo sviluppo di proxy API
• Esempio di ricettario Java: criterio XML Transform

Gestire le risorse tramite l'interfaccia utente

Gestisci le risorse con l'ambito di una revisione del proxy API utilizzando l'interfaccia utente, come descritto nelle sezioni seguenti.

Nota: non puoi gestire le risorse il cui ambito è un'organizzazione o un ambiente utilizzando la UI; devi invece utilizzare l'API.

Visualizza le risorse utilizzando l'interfaccia utente

Nota: Apigee sta introducendo una nuova versione dell'editor proxy, che semplificherà la gestione dei proxy.

Le istruzioni nelle prime due schede di seguito spiegano come utilizzare il nuovo editor proxy o la versione classica dell'editor di proxy.

Nuovo editor proxy

Per visualizzare le risorse utilizzando il nuovo editor proxy:

1. Se utilizzi l'UI di Apigee nella console Cloud: seleziona Sviluppo di proxy > Proxy API.

   Se stai utilizzando l'interfaccia utente Apigee classica: seleziona Sviluppo > Proxy API e, nel riquadro proxy, seleziona l'ambiente per il proxy di cui vuoi visualizzare le risorse.

2. Seleziona il proxy API di cui vuoi visualizzare le risorse. Viene visualizzata la visualizzazione Panoramica dell'editor proxy.

3. Fai clic sulla scheda Sviluppo.
4. Nel riquadro a sinistra, scorri verso il basso fino a Risorse. Le risorse attuali sono visualizzate sotto.

Editor proxy classico

Per visualizzare le risorse limitate all'ambito di una revisione del proxy API utilizzando l'editor proxy classico:

1. Accedi all'UI di Apigee.
2. Seleziona Sviluppo > Proxy API nella barra di navigazione a sinistra.
3. Seleziona nell'elenco un proxy API per il quale vuoi creare una risorsa.
   Si apre l'editor proxy API e per impostazione predefinita viene visualizzata la scheda Panoramica.
4. Fai clic sulla scheda Sviluppo.
5. Se necessario, seleziona la revisione nel menu a discesa Revisione.

   Le risorse interessate dalla revisione del proxy API sono elencate nella sezione Risorse della visualizzazione Navigazione.

Creare una risorsa utilizzando l'interfaccia utente

Nota: Apigee sta introducendo una nuova versione dell'editor proxy, che semplificherà la gestione dei proxy.

Le istruzioni nelle prime due schede di seguito spiegano come utilizzare il nuovo editor proxy o la versione classica dell'editor di proxy.

Nuovo editor proxy

Per creare una risorsa utilizzando il nuovo editor proxy:

1. Se utilizzi l'UI di Apigee nella console Cloud: seleziona Sviluppo di proxy > Proxy API.

   Se stai utilizzando l'interfaccia utente Apigee classica: seleziona Sviluppo > Proxy API e, nel riquadro proxy, seleziona l'ambiente per il proxy di cui vuoi visualizzare le risorse.

2. Seleziona il proxy API di cui vuoi visualizzare le risorse. Viene visualizzata la visualizzazione Panoramica dell'editor proxy.

3. Fai clic sulla scheda Sviluppo.
4. Nel riquadro a sinistra, scorri verso il basso fino a Risorse e fai clic sul pulsante + alla sua destra.
5. Nella finestra di dialogo Aggiungi risorsa, inserisci quanto segue:
   • Tipo di risorsa: seleziona il tipo di file per la risorsa.
   • In Origine, seleziona Crea un nuovo file o Importa file. Se scegli Importa file, seleziona anche un file da importare nel campo File.
   • Nome risorsa: inserisci un nome per la risorsa.
6. Fai clic su Aggiungi.

Apigee classica

Per creare risorse con ambito di una revisione del proxy API utilizzando la UI classica di Apigee:

1. Visualizza le risorse limitate all'ambito della revisione del proxy API.
2. Fai clic su + nella sezione Risorse della visualizzazione Navigazione per aprire la finestra di dialogo Nuova risorsa.
3. Inserisci quanto segue:

   Campo	Descrizione
   Origine	Scegli se creare un nuovo file o importarne uno.
   Tipo di file	Seleziona un tipo di risorsa dall'elenco a discesa.
   Nome file	Nome del file. L'estensione del nome file deve essere valida per il tipo di file selezionato.

Aggiorna una risorsa utilizzando l'UI

Aggiorna una risorsa limitata all'ambito di una revisione del proxy API solo se non è stato eseguito il deployment della revisione. Una volta eseguito il deployment, la revisione del proxy API risulta immutabile.

Per aggiornare una risorsa limitata a una revisione del proxy API utilizzando l'interfaccia utente:

1. Visualizza le risorse limitate all'ambito della revisione del proxy API.
2. Nella visualizzazione di navigazione, in Risorse, fai clic sulla risorsa che vuoi aggiornare.
   Nota: per i file JAR, posiziona il cursore sulla risorsa che vuoi modificare e fai clic su .
3. Aggiorna la risorsa in base alle esigenze.
   Nota:dopo aver caricato un nuovo file JAR, fai clic su Aggiorna.

Elimina una risorsa utilizzando l'interfaccia utente

Elimina una risorsa limitata a una revisione del proxy API solo se non è stato eseguito il deployment della revisione. Una volta eseguito il deployment, la revisione del proxy API risulta immutabile.

Per eliminare una risorsa limitata a una revisione del proxy API utilizzando l'interfaccia utente:

1. Visualizza le risorse limitate all'ambito della revisione del proxy API.
2. Nella visualizzazione Navigazione in Risorse, posiziona il cursore sulla risorsa che vuoi eliminare per visualizzare il menu delle azioni.
3. Fai clic su .
4. Fai clic su Elimina per confermare l'azione.

Gestisci le risorse utilizzando l'API

Gestisci le risorse utilizzando l'API, come descritto nelle sezioni seguenti.

Creare risorse mediante l'API

Crea risorse che hanno come ambito una revisione del proxy API o un ambiente, come descritto nelle sezioni seguenti.

Crea risorse con ambito a una revisione del proxy API utilizzando l'API

Crea risorse che abbiano come ambito una revisione del proxy API utilizzando l'API, come descritto nelle sezioni seguenti.

Nota: puoi creare una risorsa il cui ambito è una revisione del proxy API esistente solo se non è stato eseguito il deployment della revisione. Una volta eseguito il deployment, la revisione del proxy API risulta immutabile.

Per creare una risorsa limitata a una revisione del proxy API utilizzando l'API:

1. Crea il file della risorsa.
2. Aggiungi il file delle risorse a un pacchetto di configurazione del proxy API.
3. Carica il bundle utilizzando una delle seguenti API:
   • Crea proxy API
   • Aggiornamento della revisione del proxy API

Crea risorse con ambito di un ambiente utilizzando l'API

Crea risorse il cui ambito è un ambiente utilizzando l'API inviando una richiesta POST alla seguente risorsa: /organizations/$ORG/environments/$ENV/resourcefiles

Trasmetti le seguenti informazioni nella tua richiesta:

• Imposta il parametro di query name sul nome della risorsa
• Imposta il parametro di query type sul tipo di risorsa richiesto
• trasmetti i contenuti del file di risorse come application/octet-stream o multipart/form-data)

Nota: quando importi un file di risorse utilizzando l'API, potrebbe essere necessario chmod per concedere le autorizzazioni del file affinché il tuo strumento di sviluppo (ad esempio curl) possa caricarlo.

L'esempio seguente mostra come creare una risorsa JavaScript passandone i contenuti nel corpo della richiesta.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

L'esempio seguente mostra come caricare la risorsa come file dalla tua macchina locale. È importante utilizzare -F per il caricamento binario in curl affinché i file JavaScript con ambito a livello di ambiente o organizzazione siano accessibili dal criterio JavaScript.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

Di seguito è riportato un esempio della risposta:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Nota: se utilizzi un client REST, come Postman:

• Imposta Content-Type su multipart/form-data.
• Allega lo script come file.

Visualizza le risorse utilizzando l'API

Le seguenti sezioni descrivono come visualizzare le risorse utilizzando l'API.

Visualizza tutte le risorse che utilizzano l'API

Visualizza tutte le risorse limitate a un ambiente che utilizza l'API, come descritto nelle sezioni seguenti.

Utilizzando l'API puoi visualizzare le risorse con ambito solo a un ambiente.

Per visualizzare tutte le risorse in un ambiente utilizzando l'API, invia una richiesta GET alla seguente risorsa: https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles

L'esempio seguente elenca tutte le risorse nell'ambiente test:

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Per ulteriori informazioni, consulta la sezione Elenca i file di risorse dell'ambiente.

Di seguito è riportato un esempio della risposta.

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

Visualizzare i contenuti di una risorsa utilizzando l'API

Per visualizzare i contenuti di una risorsa in un ambiente utilizzando l'API, invia una richiesta GET alla seguente risorsa: /organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

Nell'esempio seguente sono elencati i contenuti del file JavaScript pathSetter.js (jsc) nell'ambiente test:

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio della risposta:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Aggiornare le risorse utilizzando l'API

Aggiorna le risorse il cui ambito è una revisione del proxy API o un ambiente, come descritto nelle sezioni seguenti.

Aggiorna le risorse con ambito a una revisione del proxy API utilizzando l'API

Nota: puoi aggiornare una risorsa il cui ambito è una revisione proxy API esistente solo se non è stato eseguito il deployment della revisione. Una volta eseguito il deployment, la revisione del proxy API risulta immutabile.

Per aggiornare una risorsa limitata a una revisione del proxy API utilizzando l'API:

1. Scarica il bundle di configurazione del proxy API utilizzando l'API di revisione del proxy API con le seguenti opzioni:
   • Imposta il parametro di query format su bundle
   • Imposta l'intestazione Accept su application/zip
2. Aggiorna il file delle risorse nel pacchetto di configurazione del proxy API.
3. Carica il bundle di configurazione del proxy API utilizzando l'API Update API proxy revision.

Aggiorna le risorse il cui ambito è un ambiente utilizzando l'API

Aggiorna una risorsa il cui ambito è un ambiente che utilizza l'API inviando una richiesta PUT alla risorsa seguente: /organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

Trasmetti i contenuti del file di risorse come application/octet-stream o multipart/form-data.

Nota: quando importi un file di risorse utilizzando l'API, potrebbe essere necessario chmodavere le autorizzazioni del file in modo che il tuo strumento di sviluppo (ad esempio curl) possa caricarlo.

L'esempio seguente mostra come aggiornare una risorsa JavaScript passandone i contenuti nel corpo della richiesta.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

L'esempio seguente mostra come aggiornare il file delle risorse utilizzando un file della macchina locale. È importante utilizzare -F per il caricamento binario in curl affinché i file JavaScript con ambito a livello di ambiente o organizzazione siano accessibili dal criterio JavaScript.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

Di seguito è riportato un esempio della risposta:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Elimina le risorse utilizzando l'API

Elimina le risorse il cui ambito è una revisione del proxy API o un ambiente, come descritto nelle sezioni seguenti.

Elimina le risorse il cui ambito è una revisione del proxy API utilizzando l'API

Nota: puoi eliminare una risorsa che rientra nell'ambito di una revisione del proxy API, se non ne è stato eseguito il deployment. Una volta eseguito il deployment, la revisione del proxy API risulta immutabile.

Con il modello ibrido, per eliminare una risorsa limitata a un proxy API utilizzando l'API:

1. Scarica il bundle di configurazione del proxy API utilizzando l'API di revisione del proxy API con le seguenti opzioni:
   • Imposta il parametro di query format su bundle
   • Imposta l'intestazione Accept su application/zip
2. Elimina il file delle risorse dal pacchetto di configurazione del proxy API.
3. Carica il bundle di configurazione del proxy API utilizzando l'API Update API proxy revision.

Elimina una risorsa limitata a un ambiente utilizzando l'API

Elimina una risorsa limitata a un ambiente utilizzando l'API, come descritto nelle sezioni seguenti.

Per eliminare una risorsa che ha come ambito un ambiente utilizzando l'API, invia una richiesta DELETE alla seguente risorsa: https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

L'esempio seguente elimina il file di risorse JavaScript pathSetter.js dall'ambiente test:

curl -X DELETE https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js \
  -H "Authorization: Bearer $TOKEN"
  

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Per saperne di più, consulta Eliminare l'API dei file di risorse.

Di seguito è riportato un esempio della risposta.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Accedi alla risorsa

Il modo in cui accedi alla risorsa dipende dal tipo di risorsa. Per saperne di più, consulta la Panoramica dei riferimenti alle norme.

Gli esempi in questa sezione mostrano come creare e gestire una risorsa JavaScript denominata pathSetter.js per fare riferimento alla risorsa in base a criteri di tipo JavaScript.

Per allegare il codice JavaScript a PostFlow della richiesta, crea un criterio denominato PathSetterPolicy.xml che faccia riferimento al file pathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Quindi, fai riferimento al criterio nella configurazione dell'endpoint:

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

Per ulteriori informazioni, consulta le norme relative a JavaScript.