Symulowanie losowych błędów dla własnej aplikacji

Z tego samouczka dowiesz się, jak używać serwera proxy deweloperów do symulowania losowych błędów dla własnej aplikacji.

Warunki wstępne

W tej części samouczka założono, że na maszynie zainstalowano i skonfigurowano serwer proxy deweloperów. Jeśli nie, zrób to teraz.

Aby wykonać ten samouczek, potrzebna jest aplikacja, która wywołuje interfejsy API. Musisz również znać adresy URL interfejsów API wywoływanych przez aplikację.

Możesz użyć serwera proxy deweloperskiego z dowolnym typem aplikacji i stosu technologii. Poniżej przedstawiono instrukcje dotyczące konfigurowania serwera proxy deweloperskiego za pomocą kilku popularnych technologii.

Użyj serwera proxy developerskiego z:

• Node.js aplikacji
• Node.js aplikacji w Dockerze
• usługi Azure Functions w języku JavaScript
• rozwiązania programu SharePoint Framework (SPFx)

.NET

Użyj serwera proxy deweloperskiego z:

• aplikacje platformy .NET
• aplikacje platformy .NET w usłudze Docker
• Aplikacje .NET Aspire

Jeśli używasz serwera proxy deweloperskiego z aplikacją .NET 4.8, musisz zarejestrować serwer proxy deweloperskiego w systemie przy użyciu netsh.

inne

Jeśli chcesz używać serwera proxy deweloperskiego z aplikacją po stronie klienta, zazwyczaj nie musisz wykonywać żadnych dodatkowych kroków. Po uruchomieniu Dev Proxy automatycznie przechwytuje wszystkie żądania z maszyny.

Jeśli chcesz użyć serwera proxy deweloperskiego z aplikacją po stronie serwera utworzoną z technologią, która nie jest wymieniona tutaj, może być konieczne wykonanie dodatkowych kroków, aby skonfigurować aplikację do korzystania z serwera proxy deweloperskiego. Zapoznaj się z dokumentacją dotyczącą technologii, aby dowiedzieć się, jak skonfigurować ją do korzystania z serwera proxy sieci. Jeśli masz jakiekolwiek pytania, poproś o pomoc w społeczności Dev Proxy na Discord.

Uruchom proxy dewelopera z monitorowaniem swoich adresów URL

Uruchom serwer proxy dev i monitoruj adresy URL interfejsów API wywoływanych przez aplikację. Jeśli na przykład aplikacja wywołuje interfejs API znajdujący się w https://api.contoso.com/v1/customers, uruchom serwer proxy deweloperów i monitoruj wzorzec adresu URL https://api.contoso.com/*.

devproxy --urls-to-watch "https://api.contoso.com/*"

Parametr --urls-to-watch informuje Dev Proxy, które żądania mają zostać przechwycone. Symbol wieloznaczny * na końcu adresu URL informuje Dev Proxy o przechwyceniu wszystkich żądań do adresów URL rozpoczynających się od https://api.contoso.com/.

Zacznij korzystać z aplikacji, jak zwykle. Serwer proxy deweloperski przechwytuje wszystkie żądania do określonych adresów URL. W wierszu polecenia widzisz komunikaty o żądaniach, które przechwytuje Dev Proxy.

```text
 request     GET https://api.contoso.com/v1/customers
     api   ╭ Passed through
           ╰ GET https://api.contoso.com/v1/customers
 request     GET https://api.contoso.com/v1/customers
   chaos   ╭ 403 Forbidden
           ╰ GET https://api.contoso.com/v1/customers

Ważny

Jeśli w wierszu polecenia nie widzisz żadnych komunikatów, upewnij się, że aplikacja została prawidłowo skonfigurowana do korzystania z serwera proxy deweloperskiego. Sprawdź również, czy Dev Proxy przechwytuje żądania do adresów URL API wykorzystywanych przez Twoją aplikację. Jeśli masz jakiekolwiek pytania, poproś o pomoc w społeczności Dev Proxy na Discord.

Tworzenie własnych plików konfiguracji

Domyślnie Dev Proxy używa pliku devproxyrc.json w folderze instalacyjnym Dev Proxy do ustawień konfiguracji. Plik jest skonfigurowany do symulowania losowych błędów dla interfejsu API JSON Placeholder. Aby uzyskać bardziej realistyczne wyniki, utwórz własne pliki konfiguracyjne z błędami, które są bardziej istotne dla Twojej aplikacji i używanych przez nią interfejsów API, i użyj ich z Dev Proxy.

Rozważmy, że chcesz przechowywać plik konfiguracji w folderze projektu dla aplikacji, aby udostępnić ustawienia konfiguracji pozostałej części zespołu.

1. W folderze instalacyjnym Dev Proxy skopiuj devproxyrc.json i devproxy-errors.json.
2. W folderze projektu wklej pliki.

W przypadku korzystania z pliku konfiguracji przechowywanego poza plikiem instalacyjnym serwera proxy deweloperów należy upewnić się, że odwołania pluginPath są poprawne. Zamiast kodować stałe ścieżki do folderu instalacyjnego serwera proxy deweloperów w pliku konfiguracji, możesz użyć ~appFolder na początku ścieżki, aby dołączyć dynamiczne odwołanie z powrotem do folderu instalacyjnego serwera proxy deweloperów.

1. W edytorze tekstów otwórz plik devproxyrc.json.
2. Znajdź wtyczkę GenericRandomErrorPlugin w tablicy plugins.
3. Zaktualizuj pluginPath na ~appFolder/plugins/dev-proxy-plugins.dll.
4. Znajdź wtyczkę RetryAfterPlugin w tablicy plugins.
5. Zaktualizuj pluginPath do ~appFolder/plugins/dev-proxy-plugins.dll.
6. W wierszu polecenia zmień katalog roboczy na folder projektu.
7. Wprowadź devproxy --config-file devproxyrc.json i naciśnij Enter, aby uruchomić serwer proxy deweloperskiego przy użyciu pliku konfiguracji.
8. Wyślij żądanie do API JSON Placeholder z wiersza polecenia i wyświetl wyjście.
9. Naciśnij Ctrl + C, aby bezpiecznie zatrzymać serwer proxy deweloperski.

Napiwek

Zainstaluj rozszerzenie Dev Proxy Toolkit dla programu Visual Studio Code, które ułatwia tworzenie i aktualizowanie plików konfiguracji.

Następny krok

Serwer proxy deweloperów obsługuje wiele różnych scenariuszy, które ułatwiają tworzenie bardziej niezawodnych aplikacji. Zapoznaj się z przewodnikami, aby dowiedzieć się, jak korzystać z różnych funkcji Dev Proxy i usprawniać swoją aplikację.

Zobacz przewodniki instruktażowe