Udostępnij za pośrednictwem

Konfigurowanie serwera proxy deweloperskiego

  • Artykuł

Serwer proxy deweloperów jest wysoce konfigurowalny. Używa wtyczek do implementowania funkcjonalności. Możesz połączyć dowolne standardowe wtyczki i utworzyć własne. Za pomocą wtyczek i niestandardowych konfiguracji można dostosować Dev Proxy do swoich konkretnych potrzeb. Serwer proxy deweloperów zawiera domyślny plik konfiguracji o nazwie devproxyrc.json. Plik znajduje się w folderze instalacyjnym Dev Proxy.

Napiwek

Zalecamy utworzenie niestandardowych plików konfiguracji. Korzystając z niestandardowych plików konfiguracji, można łatwo przełączać się między różnymi konfiguracjami i dołączać je do systemu kontroli źródła wraz z kodem projektu. Przechowywanie konfiguracji przy użyciu projektu ułatwia również udostępnianie jej zespołowi.

Jeśli nazwiesz swój plik konfiguracyjny devproxyrc.json lub devproxyrc.jsonc, serwer proxy deweloperski automatycznie ładuje go z bieżącego katalogu po jego uruchomieniu. W przypadku innych nazw określ ścieżkę pliku w argumencie --config-file podczas uruchamiania serwera proxy deweloperskiego, na przykład devproxy --config-file ./my-devproxy-config.json.

Struktura pliku konfiguracji

Poniższy fragment kodu przedstawia domyślny plik konfiguracji serwera proxy dev:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.24.0/rc.schema.json",
  "plugins": [
    {
      "name": "RetryAfterPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
    },
    {
      "name": "GenericRandomErrorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
      "configSection": "genericRandomErrorPlugin"
    }
  ],
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/*"
  ],
  "genericRandomErrorPlugin": {
    "errorsFile": "devproxy-errors.json"
  },
  "rate": 50,
  "logLevel": "information",
  "newVersionNotification": "stable",
  "showSkipMessages": true,
  "showTimestamps": true
}

Plik konfiguracji składa się z trzech sekcji:

  • Schemat zdefiniowany we właściwości $schema. Aby upewnić się, że plik konfiguracji jest prawidłowy, upewnij się, że używasz tej samej wersji schematu co używana wersja serwera proxy deweloperskiego.
  • Lista wtyczek, których używa Dev Proxy, zdefiniowanych w tablicy plugins.
  • Ogólne ustawienia konfiguracji .

Ważny

Dev Proxy aplikuje wtyczki w kolejności, w jakiej są wymienione w pliku konfiguracyjnym. Należy pamiętać o kolejności, aby uzyskać żądane zachowanie.

Niektóre wtyczki można konfigurować i uwidaczniać własne ustawienia. Każda wtyczka ma własną sekcję konfiguracji w pliku konfiguracji, do których odwołuje się właściwość configSection w definicji wtyczki. Zapoznaj się z dokumentacją referencyjną dla każdej wtyczki, aby dowiedzieć się więcej o jej opcjach konfiguracji.

Napiwek

Wartość właściwości configSection może być dowolnym ciągiem. Używając różnych nazw, można uwzględnić wiele wystąpień tej samej wtyczki, z których każda ma inną konfigurację. Może zajść potrzeba wielokrotnego użycia tej samej wtyczki, na przykład podczas symulacji różnych interfejsów API o różnych odpowiedziach błędów i zachowaniach.

Zestaw narzędzi proxy dla dewelopera

Dev Proxy Toolkit to rozszerzenie programu Visual Studio Code, które znacznie upraszcza konfigurowanie serwera proxy deweloperów. Oto niektóre funkcje, które obejmują:

  • fragmenty kodu dla typowych scenariuszy konfiguracji
  • rozszerzony linting i IntelliSense dla plików konfiguracyjnych serwera proxy dla programistów
  • niestandardowe akcje edytora i polecenia umożliwiające wygodne uruchamianie i zatrzymywanie serwera proxy deweloperskiego
  • powiadomienia o nowych wersjach serwera proxy deweloperskiego

Napiwek

Jeśli używasz programu Visual Studio Code, zalecamy zdecydowanie zainstalowanie rozszerzenia Dev Proxy Toolkit.

Następny krok

Jeśli chcesz kontynuować naukę na temat korzystania z usługi Dev Proxy, rozważ następujące samouczki:

W przeciwnym razie zapoznaj się z naszymi przewodnikami, aby dowiedzieć się, jak używać Dev Proxy w konkretnych scenariuszach.