Korzystanie z przykładów

Dodaj dane przykładowe w polach przykładów w całym API.

W API Designer można dodawać przykładowe wartości dla różnych elementów API. Po zdefiniowaniu przykładu jest on używany podczas wykonywania wywołań API do makiety.

W poniższym przykładzie typ danych został utworzony przy użyciu przykładu.

Zrzut ekranu typu danych Character, który został wygenerowany z przykładu JSON.

Ten typ danych jest następnie używany jako treść odpowiedzi dla operacji.

Typ danych Character jest zwracany dla metody o nazwie Get a Star Wars character by ID.

Przykłady można definiować w różnych częściach API, a niektóre z nich mogą nadpisywać inne podczas wykonywania wywołań do makiety. W tym przypadku używany jest przykład z typu danych, ale można również zdefiniować przykład dla odpowiedzi operacji.

Dla odpowiedzi zdefiniowano nowy przykład. W tym przypadku postacią jest Leia Organa.

Zewnętrzne przykłady nie są obsługiwane.

Czy ta strona była pomocna?

Jeżeli natkniesz się na problemy z tą stroną lub jej zawartością — literówkę, brakujący krok lub błąd techniczny — daj nam znać!

Przekaż tu opinię