Udostępnij za pośrednictwem


Dokumentacja techniczna dotycząca serwera proxy deweloperskiego

Ta sekcja zawiera informacje techniczne dotyczące wtyczek i opcji konfiguracji serwera proxy dla deweloperów.

Wtyczki

Lista wtyczek, które działają z dowolnym interfejsem API.

Nazwa/nazwisko opis
AuthPlugin Symuluje uwierzytelnianie i autoryzację przy użyciu kluczy interfejsu API lub protokołu OAuth2.
DevToolsPlugin Uwidacznia komunikaty serwera proxy deweloperów oraz informacje o przechwyconych żądaniach i odpowiedziach w narzędziu Chrome DevTools.
CachingGuidancePlugin Wyświetla ostrzeżenie, gdy serwer proxy deweloperów przechwycił to samo żądanie w określonym przedziale czasu.
CrudApiPlugin Symuluje interfejs API CRUD z magazynem danych w pamięci.
ExecutionSummaryPlugin Generuje raport podsumowania żądań przekazywanych przez serwer proxy.
GenericRandomErrorPlugin Żądania kończą się niepowodzeniem z losowo wybranym błędem z pliku zawierającego symulowane błędy.
HttpFileGeneratorPlugin Generuje plik HTTP z przechwyconych żądań i odpowiedzi.
LatencyPlugin Opóźnia odpowiedzi o losową liczbę milisekund ze skonfigurowanego zakresu.
MinimalPermissionsPlugin Sprawdza, czy aplikacja używa minimalnych uprawnień do wywoływania interfejsów API. Używa informacji o interfejsie API z określonego folderu lokalnego.
MockGeneratorPlugin Generuje makiety Dev Proxy na podstawie przechwyconych żądań.
MockRequestPlugin Umożliwia wystawianie żądań internetowych przy użyciu serwera proxy deweloperskiego.
MockResponsePlugin Symuluje odpowiedzi.
ODataPagingGuidancePlugin Wyświetla ostrzeżenie, gdy serwer proxy przechwytuje żądanie stronicowania OData przy użyciu adresu URL, który nie został wcześniej zwrócony w jednej z przechwyconych odpowiedzi.
OpenAIMockResponsePlugin Symuluje odpowiedzi z usług Azure OpenAI i OpenAI przy użyciu lokalnego modelu językowego.
OpenApiSpecGeneratorPlugin Generuje specyfikację interfejsu OpenAPI w formacie JSON z przechwyconych żądań i odpowiedzi.
RateLimitingPlugin Symuluje zachowania limitu szybkości.
RetryAfterPlugin Symuluje nagłówek Retry-After wysyłany przez API po zahamowaniu żądania.
Ponowne zapisywaniePlugin Ponownie zapisuje żądania.
UrlDiscoveryPlugin Tworzy listę adresów URL przechwyconych przez serwer proxy.

Wtyczki centrum interfejsów API platformy Azure

Lista wtyczek, które współpracują z centrum interfejsów API platformy Azure.

Nazwa/nazwisko opis
ApiCenterMinimalPermissionsPlugin Sprawdza, czy aplikacja używa minimalnych uprawnień do wywoływania interfejsów API. Używa informacji o interfejsie API z określonego wystąpienia centrum interfejsu API platformy Azure.
ApiCenterOnboardingPlugin Sprawdza, czy interfejsy API używane w aplikacji są zarejestrowane w określonym wystąpieniu Centrum API platformy Azure.
ApiCenterProductionVersionPlugin Sprawdza, czy interfejsy API używane w aplikacji są wersją produkcyjną interfejsów API zarejestrowanych w określonym wystąpieniu centrum interfejsów API platformy Azure.

Wtyczki Microsoft Entra

Lista wtyczek, które współpracują z interfejsem Microsoft Entra API.

Nazwa/nazwisko opis
EntraMockResponsePlugin Wyśmiewa odpowiedzi na firmę Microsoft Entra.

Wtyczki programu Microsoft Graph

Lista wtyczek, które działają z interfejsem MICROSOFT Graph API.

Nazwa/nazwisko opis
GraphBetaSupportGuidancePlugin Wyświetla ostrzeżenie, gdy serwer proxy wykryje żądanie do punktu końcowego programu Microsoft Graph w wersji beta.
GraphClientRequestIdGuidancePlugin Pokazuje poradę, gdy żądanie do interfejsu API programu Microsoft Graph nie zawiera nagłówka client-request-id .
GraphConnectorGuidancePlugin Przedstawia kontekstowe wskazówki dotyczące pracy z łącznikami programu Microsoft Graph.
GraphConnectorNotificationPlugin Symuluje powiadomienie podczas włączania lub wyłączania łącznika programu Microsoft Graph w Centrum administracyjnym usługi Teams (TAC). Weryfikuje żądania tworzenia i usuwania połączenia zewnętrznego.
GraphMinimalPermissionsPlugin Zwraca listę minimalnych uprawnień wymaganych dla żądań programu Microsoft Graph zarejestrowanych przez serwer proxy.
GraphMinimalPermissionsGuidancePlugin Porównuje uprawnienia używane w tokenie JWT wysyłanym do programu Microsoft Graph z minimalnymi wymaganymi zakresami wymaganymi dla żądań zarejestrowanych przez serwer proxy i pokazuje różnicę.
GraphMockResponsePlugin Wyśmiewa odpowiedzi na interfejsy API programu Microsoft Graph.
GraphRandomErrorPlugin Żądania wysyłane do programu Microsoft Graph kończą się niepowodzeniem z przypadkowymi błędami.
GraphSdkGuidancePlugin Wyświetla wskazówkę, gdy serwer proxy przechwytuje żądanie przeznaczone do usługi Microsoft Graph, które nie zostało wydane przez Microsoft Graph SDK.
GraphSelectGuidancePlugin Wyświetla ostrzeżenie, gdy serwer proxy przechwytuje żądanie do interfejsów API programu Microsoft Graph, które nie zawiera parametru $select ciągu zapytania.
ODSPSearchGuidancePlugin Wyświetla ostrzeżenie, gdy proxy deweloperski wykryje żądanie do API wyszukiwania OneDrive i SharePoint.

Reporterów

Lista reporterów, którzy generują raporty w różnych formatach.

Nazwa/nazwisko opis
JsonReporter Generuje raporty w formacie JSON.
MarkdownReporter Generuje raporty w formacie Markdown.
PlainTextReporter Generuje raporty w formacie zwykłego tekstu.

Konfigurowanie

Instrukcja opcji konfiguracji Dev Proxy.

Nazwa/nazwisko opis
devproxyrc Plik konfiguracji serwera proxy deweloperskiego.
Proxy API API do programowego interakcji z Dev Proxy.
Ustawienia serwera proxy Opcje konfiguracji ustawień serwera proxy.