nebula_api_studio library
Nebula API Studio — Public API
Main entry point for the package. Import this file to access all public classes, functions and constants.
Classes
- AnalyticsPlugin
- Collects request/response telemetry without any external dependency.
- AnalyticsSnapshot
- Full analytics snapshot at a point in time.
- ApiAst
- The root of the Abstract Syntax Tree produced from one API specification.
- ApiEndpoint
- AST node for one HTTP operation.
- ApiEnum
- AST node for a string / integer enum that will be emitted as a Dart enum.
- ApiField
- A single field inside an ApiModel.
- ApiInfo
-
Metadata extracted from the
infoblock of the spec. - ApiKeyPlugin
- Injects an API key either as a request header or a query parameter.
- ApiModel
- AST node for a schema object that will be emitted as a Dart class.
- ApiParameter
- A single parameter for an endpoint (path / query / header / body).
- ApiParser
- Base class for all spec parsers.
- ApiPlugin
- Base class for all Nebula plugins.
- ApiRequest
- A mutable descriptor for one outgoing HTTP request.
- ApiRequestBody
- Describes the request body of an endpoint.
- ApiResponse
- Immutable descriptor for one received HTTP response.
- ApiResponseSpec
- One possible response for an endpoint (keyed by HTTP status code).
- ApiSecurityScheme
-
A security scheme declared in
components/securitySchemes(OpenAPI 3) orsecurityDefinitions(Swagger 2). - ApiType
-
Base sealed class for all AST types.
Using
sealedensures exhaustive pattern matching in switch expressions. - ArrayType
-
Represents a
List<T>in Dart. - BasicAuthPlugin
-
Adds HTTP Basic Authentication (
Authorization: Basic <base64>). - CachePolicy
- Configuration object that drives caching behaviour for one request.
- CacheProvider
- Backend-agnostic cache contract.
- CancelToken
- Token that allows the caller to cancel an in-flight request.
- CodeEmitter
- CompileResult
- Returned by NebulaCompiler.compileFile on success.
- CompilerOptions
- Configuration for one compilation run.
- DefaultAdapter
- DynamicType
-
Fallback type when the spec provides no type information or uses
type: objectwithout properties. Emitsdynamicin Dart. - EmitResult
- Summary of what was generated by CodeEmitter.emit.
- EndpointMetrics
- Aggregated metrics for one endpoint.
- EnumGenerator
- EnumType
- Represents a reference to a generated Dart enum.
- ExponentialBackoff
-
Failure<
T> - The failure case of Result<T>.
- FixedDelayRetry
- Simple fixed-delay retry policy. All retries wait delay milliseconds.
- HttpAdapter
- Abstract transport layer.
- InvalidationGraph
- JwtAuthPlugin
-
Injects a Bearer token into every request's
Authorizationheader. - LoggingPlugin
- Logs HTTP traffic through the Nebula client.
- MapType
-
Represents a
Map<String, V>in Dart (OpenAPIadditionalProperties). - MemoryCache
- Fast in-memory CacheProvider backed by a LinkedHashMap.
- ModelGenerator
- NameNormalizer
- NebulaClient
- NebulaCompiler
- The main compiler facade.
- NebulaConfig
- NoRetryPolicy
- Policy that never retries. Use to disable retry on a specific request.
- NullSafetyInferrer
- OAuth2Plugin
- OAuth2 Bearer token plugin with automatic token refresh on 401.
- ObjectType
-
Represents a reference to a generated Dart class, e.g.
User,Product. - OpenApiParser
- ParseResult
- Result wrapper returned by ApiParser.parse.
- PluginChain
- PrimitiveType
-
Represents a Dart primitive:
String,int,double,bool,DateTime,dynamic,Object. - QueuedRequest
- A mutation that could not be sent and is waiting for replay.
- RequestQueue
- FIFO queue of QueuedRequests pending offline sync.
-
Result<
T> - A value that is either a Success<T> or a Failure<T>.
- RetryEngine
- Executes an operation with automatic retry according to policy.
- RetryPolicy
- Abstract policy that determines retry behaviour.
- SchemaDeduplicator
- ServiceGenerator
-
Success<
T> - The success case of Result<T>.
- SwaggerParser
- SyncEngine
- Replays queued offline requests through a NebulaClient.
- SyncResult
- Status of one sync run.
- UnionType
-
Represents a union of multiple types (OpenAPI
oneOf/anyOf). In generated Dart code this falls back to Object? unless a sealed class hierarchy is requested via generator options.
Enums
- ApiErrorType
- Classifies the root cause of an API failure.
- CacheStrategy
- The caching strategy to apply for a request.
- LogLevel
- ParameterLocation
- Where a parameter lives inside the HTTP request.
- SecuritySchemeType
- Security scheme type referenced by an endpoint.
Exceptions / Errors
- ApiError
- Normalised API error. Carried by Failure<T> in the Result type.
- CacheException
- Thrown when a CacheProvider encounters an unrecoverable error.
- CompilerException
- Thrown by NebulaCompiler for unrecoverable errors.
- ConfigException
- Thrown when NebulaConfig contains invalid or conflicting values.
- NebulaException
- Base class for all Nebula exceptions.
- ParseException
- Thrown by a parser when it encounters an unrecoverable error in the spec.
- PluginException
- Thrown when a plugin fails during its lifecycle.
- SyncException
- Thrown when the offline SyncEngine encounters a fatal error.