Creazione ed esportazione delle risorse di test

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Prima di testare le API, potresti dover creare un insieme di risorse di test, come prodotti API, sviluppatori o app, che rappresentano le stesse risorse che potrebbero esistere nell'ambiente di produzione nella tua organizzazione Apigee.

Crea ed esporta risorse di test come descritto nelle sezioni seguenti. Vedi anche Gestire cartelle e file in un'area di lavoro Apigee.

Creazione di risorse di test

Per creare risorse di test, crea un bundle di test e modifica le risorse di test definite nella tabella seguente.

Risorsa di test Descrizione
Prodotti API (products.json) Definire i prodotti API utilizzati per il bundle delle API e renderle disponibili agli sviluppatori.
Sviluppatori (developers.json) Registra gli sviluppatori che accederanno alle tue API.
App sviluppatore (developerapps.json) Registra le app per controllare l'accesso alle tue API.
Mappe chiave-valore (maps.json) Definisci le mappe chiave-valore (KVM) utilizzate dalle API per archiviare i dati per il recupero in fase di runtime.

Creazione di un bundle di test

Per creare un bundle di test in Cloud Code:

  1. Esegui una delle seguenti azioni:

    • Posiziona il cursore sulla cartella tests nella sezione Apigee e fai clic su Icona Crea. Il simbolo + viene visualizzato quando posizioni il cursore sulla cartella dei test

    • Seleziona Visualizza > Tavolozza dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: Create Apigee test bundle.

  2. Inserisci un nome univoco per il bundle di test e premi Invio.

Il bundle di test viene aggiunto alla cartella tests nella sezione Apigee.

Testa la cartella con i file developerapps.json, developers.json, maps.json e products.json

Configura le risorse di test, come descritto nelle sezioni seguenti.

Definizione dei prodotti API (products.json)

Definire i prodotti API utilizzati per il bundle delle API e renderle disponibili agli sviluppatori. Per ulteriori informazioni sui prodotti basati su API, consulta la pagina Che cos'è un prodotto API?

Per definire i prodotti API, aggiorna il file products.json utilizzando la configurazione guidata (descritta di seguito) o modificando direttamente il file di configurazione product.json. Per una descrizione dei campi del file products.json, consulta Risorsa: ApiProduct.

Per definire i prodotti API utilizzando la configurazione guidata:

  1. Posiziona il cursore sul file products.json per il bundle di test e fai clic su Icona della procedura guidata. Si apre la procedura guidata Create API (Crea prodotto API).

    Prima pagina della procedura guidata del prodotto Create API

  2. Segui la procedura guidata di configurazione per compilare automaticamente i campi nel file products.json.
    Il file products.json viene aperto nell'editor.

  3. Modifica le informazioni di configurazione, come richiesto.

  4. Seleziona File > Salva o ⌘S per salvare le modifiche.

L'esempio seguente definisce il prodotto API myapiproduct che contiene il proxy API helloworld.

[
  {
    "apiResources": [
      "/",
      "/*",
      "/**"
    ],
    "quota": "100",
    "quotaInterval": "1",
    "quotaTimeUnit": "minute",
    "name": "myapiproduct",
    "displayName": "My first API product",
    "proxies": [
      "helloworld"
    ]
  }
]

Registrazione degli sviluppatori (developers.json)

Registra gli sviluppatori che accederanno alle tue API. Per maggiori informazioni sugli sviluppatori, consulta l'articolo Registrazione degli sviluppatori di app.

Per registrare gli sviluppatori, aggiorna il file developers.json utilizzando la configurazione guidata (descritta di seguito) o modificando direttamente il file di configurazione developers.json. Per una descrizione dei campi del file products.json, vedi Risorsa: sviluppatore.

Per registrare gli sviluppatori utilizzando la configurazione guidata:

  1. Posiziona il cursore sul file developers.json del bundle di test e fai clic su Icona della procedura guidata.
  2. Segui la procedura guidata di configurazione per compilare automaticamente i campi nel file developers.json.
    Il file developers.json viene aperto nell'editor.
  3. Modifica la configurazione, come richiesto.
  4. Seleziona File > Salva o ⌘S per salvare le modifiche.

L'esempio seguente definisce lo sviluppatore ahamilton@example.com:

[
  {
    "email": "ahamilton@example.com",
    "userName": "ahamilton",
    "firstName": "Alex",
    "lastName": "Hamilton"
  }
]

Registrazione di app sviluppatore (developerapps.json)

Registra le app sviluppatore per controllare l'accesso alle tue API. Per ulteriori informazioni sulla registrazione di app per sviluppatori, consulta Controllo dell'accesso alle API tramite la registrazione delle app.

Per registrare le app degli sviluppatori, aggiorna il file developerapps.json utilizzando la configurazione guidata (descritta di seguito) o modificando direttamente il file di configurazione developerapps.json. Per una descrizione dei campi nel file developerapps.json, vedi Risorsa: DeveloperApp.

Per registrare le app sviluppatore utilizzando la configurazione guidata:

  1. Posiziona il cursore sul file developerapps.json del bundle di test e fai clic su Icona della procedura guidata.

  2. Segui la procedura guidata di configurazione per compilare automaticamente i campi nel file developerapps.json.
    Il file developerapps.json viene aperto nell'editor.

  3. Modifica la configurazione, come richiesto.

  4. Seleziona File > Salva o ⌘S per salvare le modifiche.

L'esempio seguente registra l'app sviluppatore myapp per ahamilton@example.com e associa myproduct:

[
  {
    "attributes": [
      {
        "name": "sample_attribute_0",
        "value": "sample_attribute_value_0"
      }
    ],
    "developerEmail": "ahamilton@example.com",
    "name": "myapp",
    "callbackUrl": "",
    "keyExpiresIn": "never",
    "apiProducts": [
      "myproduct"
    ]
  }
]

Definizione delle mappe chiave-valore (maps.json)

Definisci le mappe chiave-valore (KVM) utilizzate dalle API per archiviare i dati per il recupero in fase di runtime. Per ulteriori informazioni sulle KVM, consulta Utilizzo delle mappe chiave-valore.

Per definire le mappe chiave-valore, aggiorna il file maps.json utilizzando la configurazione guidata (descritta di seguito) o modificando direttamente il file di configurazione maps.json. Per una descrizione dei campi del file maps.json, vedi Risorsa KeyValueMap.

Per registrare le app sviluppatore mediante la configurazione guidata:
1. Posiziona il cursore sul file maps.json del bundle di test e fai clic su Icona della procedura guidata. 2. Segui la procedura guidata di configurazione per compilare automaticamente i campi nel file maps.json.
Il file maps.json viene aperto nell'editor.
3. Modifica la configurazione, come richiesto. 4. Seleziona File > Salva o ⌘S per salvare le modifiche.

L'esempio seguente definisce la KVM criptata mykvm:

[
  {
    "name": "mykvm",
    "encrypted": true
  }
]

Esportazione delle risorse di test nell'emulatore Apigee

Per esportare le risorse di test nell'emulatore Apigee:

  1. Posiziona il cursore sul bundle di test che vuoi esportare e fai clic su Icona Esporta test.

    L'icona Esporta viene visualizzata quando posizioni il cursore sul nome del bundle di test

  2. Se sono in esecuzione più container per l'emulatore Apigee, seleziona quello in cui vuoi eseguire il deployment dell'ambiente.

Le risorse di test attive vengono visualizzate nell'emulatore Apigee, come mostrato nella figura seguente.

Risorse di test attive, tra cui prodotti API, sviluppatori e app per sviluppatori

Visualizza i contenuti della risorsa di test per ottenere informazioni specifiche sulle risorse, ad esempio una chiave API per i test, che viene generata automaticamente e inclusa nella risorsa di test dell'app sviluppatore.

Passaggi successivi

Ora è il momento di eseguire il deployment in un ambiente.