Generowanie odpowiedzi za pomocą makiet API

Makiety API odpowiadają na otrzymywane wywołania w sposób jak najbardziej realistyczny. Podczas generowania treści odpowiedzi makieta nadaje priorytet danym dostarczonym przez użytkownika, szukając pola przykładu, następnie wartości domyślnej, a następnie pola wyliczeniowego. Jeśli zostanie znalezione, zostanie użyte jako przykład, w przeciwnym razie wygenerowany zostanie przykład w formacie JSON na podstawie typu danych zwracanego przez wywoływaną operację.

Jako przykład rozważmy przedstawioną poniżej definicję typu danych Company. Nie zawiera ona żadnych przykładów dostarczonych przez użytkownika.

Po aktywowaniu makietowania wywołanie GET do zasobu /company/{companyId} zwróci automatycznie wygenerowaną odpowiedź JSON na podstawie struktury typu danych.

Makieta wykonała szereg interesujących rzeczy, w tym wygenerowała wartości dla niestandardowych nagłówków odpowiedzi (np. x-my-custom-header), zidentyfikowała tablice i utworzyła odpowiednie przykłady (np. właściwość tags), a także zidentyfikowała zagnieżdżone struktury i wygenerowała wartości również dla nich (np. właściwość address).

Makiety API Designer obsługują negocjację treści, dzięki czemu można użyć nagłówka żądania Accept, aby wybrać, która treść powinna zostać zwrócona spośród kilku opcji (z których każda może mieć własny przykład), zmieniając w ten sposób przykłady zwracane przez makietę.