api_studio library

Classes

ApiCookieJar
Minimal in-memory cookie jar for ApiStudioClient.
ApiInspectorTheme
ApiInspectorThemeData
ApiInterceptor
Base class for ApiStudioClient interceptors.
ApiLogEntity
ApiLogNotificationModel
ApiLogRepository
ApiMultipartFile
Represents a single file part in a multipart/form-data request.
ApiRequestOptions
Encapsulates every configurable aspect of a single HTTP request.
ApiResponse<T>
Generic HTTP response returned by ApiStudioClient.
ApiStudio
Entry point for API Studio: configuration, capture and UI.
ApiStudioClient
Optional built-in HTTP client, useful for manual testing.
ApiStudioNavigationScreen
Unified API Studio container screen.
ApiStudioNavigatorObserver
Records screen changes as crash breadcrumbs.
AppColors
AppConstants
Package-wide constants.
AuthConfig
Provides authentication headers that are injected before every request.
CachePolicy
Per-request cache policy.
CancelToken
Token used to cancel an in-flight ApiStudioClient request.
ClearLogsUseCase
ClientConfig
Global configuration for ApiStudioClient.
ConnectivityChangeRecord
ConnectivityPerformance
CurlGenerator
Generates POSIX-shell-safe cURL commands from captured logs.
DeleteLogUseCase
EditRunScreen
ErrorInterceptorHandler
Handler forwarded to error interceptors.
Failure
FileExplorerContent
FileExplorerEntry
FileExplorerList
FileExplorerRepository
FileExplorerScreen
Read-only browser for the app's sandboxed files.
FileExplorerView
FileTypeHelper
FrameMetrics
GetLogsParams
GetLogsUseCase
HiveConstants
Storage constants used by API Studio's local log persistence.
InspectorDetailScreen
InspectorListScreen
ListDirectoryUseCase
MemoryCacheStore
Lightweight in-memory cache for ApiStudioClient responses.
MemoryMetrics
NetworkFailure
NetworkPerformance
NetworkRequestPerformance
NotificationConfig
NotificationProvider
NotificationService
PerformanceEvent
PerformanceInspectorScreen
PerformanceInspectorView
PerformanceRepository
PerformanceSnapshot
ProxyConfig
Proxy configuration for ApiStudioClient.
RedactionConfig
Controls how API Studio masks sensitive data.
RequestInterceptorHandler
Handler forwarded to request interceptors.
ResponseInterceptorHandler<T>
Handler forwarded to response interceptors.
RetryConfig
Controls how ApiStudioClient retries failed requests.
RunRequestParams
RunRequestUseCase
SaveLogUseCase
ScreenPerformance
SensitiveDataMasker
SlackProvider
Posts failed requests to a Slack Incoming Webhook from the device.
SslConfig
SSL / TLS configuration for ApiStudioClient.
StartupMetrics
StartupPhase
StorageFailure
UnexpectedFailure

Enums

ApiHttpMethod
HTTP methods supported by ApiStudioClient.
ApiResponseType
Determines how the response body is parsed.
ApiStudioFeature
Optional add-ons shown next to API Logs (the core of API Studio).
AuthType
Authentication strategy used by ApiStudioClient.
DuplicateRequestStrategy
How the client handles duplicate in-flight requests for the same key.
FileExplorerEntryType
FrameSeverity
HttpMethod
LogStatus
MemoryTrend
MethodFilter
PerformanceEventSeverity
PerformanceEventType
PerformanceHealthGrade
ScreenPerformanceStatus
SortOrder
StatusFilter

Typedefs

ApiStudioRedactor = ApiLogEntity Function(ApiLogEntity log)
Signature of a custom redaction hook.
ProgressCallback = void Function(int count, int total)

Exceptions / Errors

ApiStudioException
Base class for all ApiStudioClient exceptions.
BadResponseException
The server returned an unexpected response that could not be parsed.
CancelledException
The request was cancelled via a CancelToken.
ForbiddenException
The server returned a 403 Forbidden response.
NetworkException
Generic network-level error (DNS failure, socket reset, etc.).
NoInternetException
No network connectivity when request was fired.
ServerException
The server returned a 5xx response.
SslException
SSL/TLS handshake or certificate verification failed.
StorageException
TimeoutException
Connection timed out before a response was received.
UnauthorizedException
The server returned a 401 Unauthorized response.
UnknownException
Catch-all for unexpected errors.