Ambiente di test delle API di Explorer

Cos'è l'ambiente nello strumento di test Apigit

L'ambiente di Apigit è una funzionalità che ti consente di creare e gestire diversi set di variabili che possono essere utilizzati nelle tue richieste. Un ambiente può essere pensato come una raccolta di coppie chiave-valore a cui è possibile accedere e modificare all'interno di Apigit.

In termini più semplici, un ambiente è un modo per archiviare variabili come URL, token di accesso e altri valori che vengono utilizzati di frequente nelle richieste API. Memorizzando questi valori in un ambiente, puoi facilmente passare da una configurazione all'altra ed eseguire le tue richieste su ambienti diversi senza aggiornare manualmente i valori ogni volta.

Ogni ambiente in Apigit è costituito da un insieme di variabili, comprese variabili globali a cui possono accedere tutte le richieste nell'area di lavoro e variabili specifiche dell'ambiente che sono disponibili solo per le richieste all'interno di tale ambiente. Le variabili possono essere impostate e aggiornate manualmente oppure possono essere impostate dinamicamente utilizzando gli script o l'API Apigit.

Puoi creare più ambienti all'interno di un'area di lavoro Apigit e passare facilmente da uno all'altro utilizzando il menu a discesa dell'ambiente. In questo modo è facile testare la tua API in ambienti diversi, come sviluppo, staging e produzione, senza dover aggiornare manualmente le tue richieste ogni volta.

Crea il tuo primo set di ambienti

Quando si esegue il debug di un'API, spesso è necessario passare avanti e indietro tra ambienti locali, di sviluppo e di produzione. Affrontiamo anche problemi come i token scaduti, che possono essere frustranti. Alcuni tutorial suggeriscono di utilizzare Apigit per semplificare il processo, ma in pratica potremmo ancora riscontrare alcuni problemi. Pertanto, questo post di blog dettagliato introduce l'uso degli ambienti di Apigit per semplificare i passaggi del passaggio tra ambienti diversi durante il debug delle API senza interruzioni.

Passaggi per utilizzare un ambiente dati globale:

Per modificare il file del test case, vai aTest Cases all'interno del tuo repository e seleziona il file appropriato. Nella modalità di visualizzazione predefinita, fai clic sull'icona ✏️ situata nell'angolo in basso a sinistra della barra laterale.

Per aggiungere o modificare un set di ambienti, fare clic suEnv pulsante situato al centro della barra in alto. Da lì, puoi accedere alle impostazioni dell'ambiente e apportare le modifiche necessarie.

Hai la possibilità di passare da uno all'altroCode EForm modalità di visualizzazione cliccando sui pulsanti corrispondenti situati nell'angolo in alto a destra della pagina.

InCode modalità:

[
  {
    "type": "code",
    "description": "initialization",
    "parameters": {
      "code": "var baseUrl = env.get(\"baseUrl\");\nvar test = env.get(\"username\");\nif (test == null){\n    fail(\"test is null\");\n}\nif (baseUrl == null) {\n    state.baseUrl = \"http://petstore.mock.apigit.com\";\n    //env.set(\"baseUrl\", \"http://petstore.mock.apigit.com\")\n}\nstate.test = test;\n"
    }
  },
  {
    "type": "http",
    "description": "get pet inventories by username",
    "parameters": {
      "method": "get",
      "url": "{baseUrl}/store/inventory/{test}",
      "query": [],
      "auth": {
        "type": "{test}"
      },
      "header": [],
      "body": {
        "type": "none",
        "data": ""
      },
      "postTest": "if (!res || res.status !== 200) {\n    fail(\"get pet inventory failed\")\n}"
    }
  }
]

InForm modalità:

Per utilizzare i dati dell'ambiente, puoi aggiungere del codiceCode Execution Action OTest sezione diHttp Request Action.

Si noti che l'uso divar è limitato alla propria sezione. Se definisci una variabile, ad esempiotest, all'interno della sezioneCode Execution Action e desideri utilizzarlo all'interno diHTTP Request Action sezione, è necessario utilizzarestate.test per accedere alla variabile.