Costruisci e configura uno strumento

Inizia con la documentazione API ufficiale per il servizio aziendale e un'attività che il tuo account è autorizzato a eseguire. Uno strumento ristretto e ben descritto è più facile da testare rispetto a uno strumento generico che accetta un URL e un metodo arbitrari.

Definire la richiesta#

Assegna allo strumento un nome stabile e una descrizione che ne spieghi lo scopo, i limiti importanti e se modifica i dati. Seleziona il metodo e l'endpoint HTTP documentati. Utilizzare i segnaposto solo per gli elementi del percorso variabile effettivamente consentiti dall'operazione.

Per una ricerca di record fittizi, il percorso potrebbe contenere un identificatore di record. Il nome host e la regione dell'account devono rimanere parte della connessione configurata anziché input del modello a tempo indeterminato.

Definire e mappare gli input#

Utilizza lo schema di input per descrivere ciascun campo, il relativo tipo, lo stato richiesto e i valori validi. Un piccolo schema per una ricerca fittizia è:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Mappare gli argomenti sul percorso documentato, sulla query o sui campi del corpo. Controlla che i campi obbligatori mancanti e gli argomenti aggiuntivi imprevisti falliscano chiaramente. Mantieni l'autenticazione nella connessione al server supportato, non in un prompt, in uno schema di esempio o in un'intestazione dello strumento codificata.

Dai forma all'output#

La mappatura o la trasformazione della risposta può restituire i campi necessari al flusso di lavoro invece di un'intera risposta del servizio. Verificare l'output trasformato rispetto al risultato del test originale. Non rimuovere l'identificatore del record, le informazioni sull'impaginazione o i dettagli dell'errore necessari per capire se il risultato è completo.

Rivedere le impostazioni operative#

La configurazione dello strumento supporta le impostazioni di timeout, memorizzazione nella cache e tentativi. Utilizzare la memorizzazione nella cache solo quando i dati obsoleti sono accettabili; una lettura memorizzata nella cache non è adatta come prova finale che una scrittura è appena stata completata. Ritentare una scrittura non idempotente può creare duplicati, quindi scegli il comportamento dei tentativi dalle garanzie documentate dell'API.

Prova il vero percorso#

Controlla l'input corretto, l'input non valido, i risultati vuoti, l'autorizzazione non riuscita e una chiamata riuscita limitata. La diagnostica del test può contenere informazioni sensibili sulle richieste; ispezionarli solo attraverso il percorso dell'amministratore approvato e redigerli prima di condividerli. Vedere test prima che un cliente utilizzi lo strumento.