Tworzenie i konfiguracja narzędzia

Zacznij od oficjalnej dokumentacji API dla usługi biznesowej i zadania, które Twoje konto jest dozwolone. Jeden wąski, dobrze opisany narzędzie jest łatwiejsza do testowania niż ogólne narzędzie, które akceptuje arbitralny URL i metodę.

Definiuj żądanie#

Podaj narzędzie stałej nazwy i opisu, który wyjaśnia jego cel, ważne limity i czy zmienia dane. Wybierz udokumentowaną metodę HTTP i punkt końcowy. Użyj tylko GATT dla zmiennych elementów ścieżki, które operacja faktycznie pozwala.

Dla fikcyjnego odnalezienia rekordu ścieżka może zawierać identyfikator rekordu. Nazwa użytkownika i region konta powinny pozostać częścią skonfigurowanego połączenia, a nie otwartego wejścia modelu.

Definicja i mapa wejścia#

Użyj schematu wejścia, aby opisać każde pole, jego typ, wymagany status i prawidłowe wartości. Mały schemat dla fikcyjnego odnalezienia jest:

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

Argumenty mapy do udokumentowanej ścieżki, pola zapytania lub ciała. Sprawdź, czy brak wymaganych pól i nieoczekiwanych dodatkowych argumentów jednoznacznie się nie powiodło. Zachować uwierzytelnianie w obsługiwanym połączeniach serwera, nie w szybkim, na przykład schematu lub nagłówek narzędzia hard-coded.

Tworzenie wyjścia#

Mapowanie odpowiedzi lub transformacja może zwrócić pola potrzebne do przepływu pracy zamiast całej odpowiedzi serwisowej. Sprawdzić przekształcone wyjście w stosunku do oryginalnego wyniku testu. Nie usuwać identyfikatora rekordu, informacji paginacji lub szczegółów błędu potrzebne, aby zrozumieć, czy wynik jest kompletny.

Przegląd ustawień operacyjnych#

Konfiguracja narzędzia obsługuje ustawienia czasu, buforowania i odkupienia. Użyj buforowania tylko wtedy, gdy dane są możliwe do przyjęcia; odczyt w pamięci jest nieodpowiedni jako dowód na to, że zapis został właśnie zakończony. Ponowne użycie zapisu nie domyślnego może tworzyć kopiowania, więc należy wybrać zachowanie ponownie z udokumentowanych gwarancji API.

Sprawdź prawdziwą ścieżkę#

Sprawdź prawidłowe wejście, nieprawidłowe wejście, puste rezultaty, awarię zezwolenia i zakończony sukces wywołania. Diagnostyka testu może zawierać informacje o wrażliwych prośbach; sprawdź je tylko przez zatwierdzony sposób zarządzania i ponowne działanie przed współdzieleniem. testowanie zanim klient użyje narzędzia.