Zachowanie mocków
Mocki dostarczają w większości statyczne odpowiedzi na żądania, które odpowiadają kontraktowi API. Odpowiadają na żądania bez względu na jakiekolwiek zabezpieczenia zdefiniowane w API, ładunek żądania lub nagłówki żądania (z wyjątkiem nagłówka Accept, który jest używany do negocjacji treści).
Po wysłaniu żądania mock tworzy odpowiedź na podstawie tego, co podał użytkownik (przykład, wartość domyślna, wartość wyliczeniowa), lub przy użyciu wbudowanej wartości przykładowej.
Na przykład, jeśli żądanie zwraca obiekt, używany jest przykład obiektu, jeśli został podany. Jeśli nie, używane są przykłady dla każdej z właściwości i na ich podstawie tworzony jest obiekt JSON. Działa to również w przypadku nagłówków odpowiedzi.
Odpowiedzi
- Jeśli operacja ma tylko zakres odpowiedzi, zwracany jest pierwszy status z tego zakresu. Na przykład operacja z zakresem odpowiedzi 2XX zwraca odpowiedź 200.
- Jeśli operacja ma określony kod odpowiedzi i zakresy odpowiedzi lub odpowiedź domyślną, zwracany jest zdefiniowany kod. Na przykład operacja z odpowiedzią 201 i zakresem odpowiedzi 3XX zwraca odpowiedź 201.
- Jeśli operacja ma kilka zakresów odpowiedzi i nie ma zdefiniowanego statusu odpowiedzi, zwracany jest pierwszy status z pierwszego zakresu. Na przykład operacja z zakresem odpowiedzi 4XX i 5XX zwraca odpowiedź 400.
- Jeśli operacja ma tylko odpowiedź domyślną, zwracana odpowiedź zależy od metody operacji:
- Jeśli używaną metodą jest POST, zwracana jest odpowiedź 201.
- W przypadku innych metod zwracana jest odpowiedź 204, jeśli nie zdefiniowano treści odpowiedzi, a odpowiedź 200 jest zwracana, jeśli treść odpowiedzi została zdefiniowana.
- Jeśli operacja nie ma zdefiniowanej odpowiedzi, zwracana jest odpowiedź 200.
- Odpowiedzi 1XX nie są obsługiwane przez mocki. Jeśli operacja ma zakres odpowiedzi 1XX lub zdefiniowany kod odpowiedzi w tym zakresie, zwracana jest odpowiedź 404.
Kombinacje
- All of: jeśli zdefiniowano przykład, jest on zwracany. Jeśli nie zdefiniowano przykładu dla typu danych, właściwości typów są łączone i używane są przykłady zdefiniowane na poziomie właściwości lub generowane są wartości przykładowe. Jeśli właściwość jest zdefiniowana dwukrotnie w różnych typach, zachowywana jest tylko ostatnia wartość. Typy proste są odrzucane, zwracane są tylko obiekty.
- Any of lub One of: jeśli zdefiniowano przykład, jest on zwracany. Jeśli nie zdefiniowano przykładu, odpowiedź jest generowana z pierwszego typu na liście.
Ograniczenia
- Dostępne tylko w żądaniu: właściwość jest wykluczona z wygenerowanego przykładu.
- Dostępne tylko w odpowiedzi: właściwość jest uwzględniona w wygenerowanym przykładzie.
- Dostępne w żądaniu i odpowiedzi: właściwość jest uwzględniona w wygenerowanym przykładzie.
Przykłady podane na poziomie typu danych mają pierwszeństwo przed właściwościami. Jeśli właściwość zdefiniowana jako Dostępne tylko w żądaniu jest uwzględniona w przykładzie, jest ona zwracana w odpowiedzi. Jeśli właściwość zdefiniowana jako Dostępne tylko w odpowiedzi lub Dostępne w żądaniu i odpowiedzi nie jest uwzględniona w przykładzie, nie jest ona zwracana w odpowiedzi.