Modifica di un proxy API (creazione di una revisione del proxy)

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Utilizza la UI o l'API Apigee per modificare un proxy API. Quando modifichi un proxy API, puoi decidere quale delle seguenti operazioni relative alle modifiche risultanti:

  1. Salva le modifiche sul server, ma non creare una nuova revisione. Se scegli di non farlo, vuoi eseguire il deployment delle modifiche salvate, ma vuoi assicurarti che non vadano perse durante la sessione.

    OR

  2. Crea una nuova revisione del proxy API e esegui il deployment nel cluster. Non puoi eseguire il deployment di modifiche proxy API senza crearne una nuova revisione.

Nuovo editor proxy

Per modificare un proxy API e salvare le modifiche utilizzando il nuovo editor proxy:

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

    Se utilizzi la UI di Apigee classica: seleziona Sviluppa > Proxy API e nel riquadro Proxy, seleziona l'ambiente per il proxy.

  2. Seleziona il proxy che vuoi modificare dall'elenco dei proxy. L'interfaccia utente mostra la scheda Panoramica del proxy nell'editor dei proxy.

    Scheda Panoramica nell'editor proxy
  3. Fai clic sulla scheda Sviluppo.
  4. Utilizza l'Editor proxy per apportare le modifiche al proxy. Al termine delle modifiche, puoi eseguire una delle seguenti operazioni:
    • Per salvare le modifiche ma non creare una nuova revisione, fai clic sul pulsante Salva . (devi eseguire questa operazione periodicamente per assicurarti che le modifiche non vadano perse se termini la sessione).
    • Per salvare le modifiche come nuova revisione (quando ti stai preparando a eseguire il deployment e il test), fai clic sul menu a discesa accanto al pulsante Salva e seleziona Salva come nuova revisione:

      Salva le modifiche come nuova revisione nel menu Salva.

      L'interfaccia utente di Apigee salva le modifiche e genera una nuova revisione del proxy. it non esegue il deployment il nuovo bundle al runtime; devi farlo esplicitamente, come descritto in Deployment di un proxy API.

Editor proxy classico

Per modificare un proxy API e salvare le modifiche utilizzando l'editor proxy classico:

  1. Accedi all'interfaccia utente di Apigee.
  2. Fai clic su Proxy API nella vista principale.

    In alternativa, puoi selezionare Sviluppo > Proxy API nel menu di navigazione a sinistra o dal menu Fogli Google.

  3. Seleziona l'ambiente contenente il proxy che vuoi modificare.

    L'interfaccia utente di Apigee mostra un elenco di proxy API per l'ambiente selezionato:

    Elenco di proxy per l'ambiente selezionato.

  4. Fai clic sul proxy che vuoi modificare. Nella UI viene visualizzata la scheda Panoramica questo proxy nell'Editor proxy:

    Panoramica dell'Editor proxy.

  5. Fai clic sulla scheda Sviluppa in alto a destra nella visualizzazione.
  6. Utilizza l'editor proxy per apportare le modifiche al proxy. Al termine delle modifiche, puoi eseguire una delle seguenti operazioni:
    • Salva le modifiche, ma non creare una nuova revisione (opzione più comune; devi eseguire questa operazione periodicamente per assicurarti che le modifiche non vadano perse se termini la sessione).
    • Salva le modifiche come nuova revisione (quando ti stai preparando a eseguire il deployment e il test).
  7. Per salvare ma non crearne una nuova, fai clic su Salva. in alto a destra nell'interfaccia utente:

    Pulsante Salva.

    La UI di Apigee salva le modifiche in modo che tu possa uscire dalla pagina e riprendere a lavorare in un secondo momento.

  8. Per salvare le modifiche come nuova revisione, fai clic sulla freccia del menu a discesa accanto a Salva e seleziona Salva come nuova revisione:

    Fai clic su Salva come nuova revisione.

    La UI di Apigee salva le modifiche e genera un nuovo bundle proxy per te. Non esegue il deployment del nuovo bundle nel runtime; devi farlo esplicitamente, come descritto in Eseguire il deployment di un proxy API.

    Nella UI viene visualizzato il messaggio Nuova revisione salvata:

    Nuovo messaggio salvato per la revisione visualizzato nell'interfaccia utente.

    Dopo aver creato una nuova revisione, in genere la esegui nel cluster, come descritto in Eseguire il deployment di un proxy API.

API Apigee

Modifica un proxy API per creare una revisione nella tua organizzazione Apigee inviando un POST alla seguente risorsa:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

Devi definire il nome del proxy API utilizzando il parametro di query name. Limita i caratteri utilizzati nel nome come segue: A-Za-z0-9._\-$ %

Facoltativamente, puoi importare un bundle di configurazione del proxy API seguendo questi passaggi:

  • Imposta il parametro di query action su import
  • Imposta l'intestazione Content-type su multipart/form-data
  • Passa il nome del pacchetto di configurazione del proxy API nel file system locale

Il seguente esempio mostra come modificare un proxy API importando un bundle di configurazione del proxy API (helloworld-config.zip) nel file system locale utilizzando l'API.

export TOKEN=$(gcloud auth print-access-token)
export ORG=ORGANIZATION_NAME
curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

dove $TOKEN è impostato sul tuo 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 Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di output della risposta:

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

Per saperne di più sulla modifica di un proxy API, consulta il metodo apis.create nell'API Apigee. Per visualizzare tutti i metodi disponibili per i proxy API, consulta l'API Proxy API.