openapi_base library
Classes
- ApiEndpoint
-
ApiEndpointProvider<
ENDPOINT extends ApiEndpoint> - ApiUuid
- ApiUuidJsonConverter
-
HasSuccessResponse<
BODY_TYPE> - HttpClientResponse
- HttpRequestSender
- OpenApiRequestSender implementation based on package:http for cross platform compatibility.
- OpenApiClient
- Base class for generated client classes for OpenAPI apis.
- OpenApiClientBase
- OpenApiClientRequest
- OpenApiClientRequestBody
- OpenApiClientRequestBodyBinary
- OpenApiClientRequestBodyJson
- OpenApiClientRequestBodyText
- OpenApiClientResponse
- OpenApiContent
- OpenApiContentType
- Represents the content type header describing content encoding for request and responses.
- OpenApiGetRequestSender
- Api sender implementing the actual HTTP protocol. See HttpRequestSender.
- OpenApiHttpHeaders
- OpenApiHttpStatus
- OpenApiRequest
- OpenApiRequestSender
- Api sender implementing the actual HTTP protocol. See HttpRequestSender.
- OpenApiResponse
- OpenApiResponseBodyBinary
- OpenApiResponseBodyJson
- OpenApiResponseBodyString
- OpenApiResponseWithBody
- OpenApiServerBase
- OpenApiServerRouterBase
- OpenApiShelfServer
- Noop server used if no dart:io is available.
- RouteConfig
- SecurityRequirement
- SecurityRequirementScheme
-
SecurityScheme<
T extends SecuritySchemeData> - SecuritySchemeApiKey
- SecuritySchemeApiKeyData
- SecuritySchemeData
- SecuritySchemeHttp
- SecuritySchemeHttpData
-
StaticEndpointProvider<
ENDPOINT extends ApiEndpoint> - StoppableProcessBase
- UserAgentClient
- Add a user-agent adder to the given value.
Mixins
Extensions
-
HasSuccessFuture
on Future<
HasSuccessResponse< BODY_TYPE> > -
SecuritySchemeClient
on SecurityScheme<
T>
Functions
-
operationFromString(
String operation) → Operation
Typedefs
-
ApiEndpointCallback<
ENDPOINT extends ApiEndpoint, RET> = Future< RET> Function(ENDPOINT impl) - ClientCreator = Client Function()
- Allows to customize how a Client is created. For example acn be used to use UserAgentClient to add user agent header.
-
ResponseMap<
T, R> = R Function(T response) -
ResponseParser<
T extends OpenApiResponse> = Future< T> Function(OpenApiClientResponse response) -
RouteHandler
= Future<
OpenApiResponse> Function(OpenApiRequest request)
Exceptions / Errors
- ConflictException
- MissingParameterException
- NotFoundException
- OpenApiResponseException
- Base class for exceptions which can be thrown by endpoint implementations with special handling in the server implementations (e.g. OpenApiShelfServer).
- Server exception which can be thrown by implementations of the server endpoint to indicate a 401 response status.
- UnexpectedResponseException