Bygg och konfigurera ett verktyg

Börja med den officiella API-dokumentationen för företagstjänsten och en uppgift som ditt konto har tillåtelse att utföra. Ett smalt, välbeskrivet verktyg är lättare att testa än ett generiskt verktyg som accepterar en godtycklig URL och metod.

Definiera begäran#

Ge verktyget ett stabilt namn och en beskrivning som förklarar dess syfte, viktiga gränser och om det ändrar data. Välj den dokumenterade HTTP-metoden och slutpunkten. Använd endast platshållare för de variabla sökvägselementen som operationen faktiskt tillåter.

För en fiktiv postsökning kan sökvägen innehålla en postidentifierare. Värdnamnet och kontoområdet bör förbli en del av den konfigurerade anslutningen snarare än indata för öppen modell.

Definiera och kartlägga ingångar#

Använd inmatningsschemat för att beskriva varje fält, dess typ, obligatoriska status och giltiga värden. Ett litet schema för en fiktiv sökning är:

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

Mappa argument till den dokumenterade sökvägen, frågan eller brödtextfälten. Kontrollera att saknade obligatoriska fält och oväntade extra argument misslyckas tydligt. Behåll autentiseringen i serveranslutningen som stöds, inte i en prompt, exempelschema eller hårdkodad verktygshuvud.

Forma utgången#

Responsmappning eller transformation kan returnera de fält som arbetsflödet behöver istället för ett helt servicesvar. Verifiera den transformerade utgången mot det ursprungliga testresultatet. Ta inte bort postidentifieraren, sidnumreringsinformation eller feldetaljer som behövs för att förstå om resultatet är komplett.

Granska driftsinställningarna#

Verktygskonfigurationen stöder inställningar för timeout, cachning och försök igen. Använd cachning endast när inaktuella data är acceptabelt; en cachad läsning är olämplig som slutgiltigt bevis på att en skrivning just avslutats. Om du försöker igen en icke-idempotent skrivning kan det skapa dubbletter, så välj ett nytt försök från API:s dokumenterade garantier.

Testa den verkliga vägen#

Kontrollera korrekt inmatning, ogiltig inmatning, tomma resultat, behörighetsfel och ett avgränsat lyckat samtal. Testdiagnostik kan innehålla känslig information om begäran; inspektera dem endast via den godkända administratörsvägen och redigera dem innan de delar. Se testning innan en klient använder verktyget.