jaguar.retrofit library

Support for doing something awesome.

More dartdocs go here.

Classes

ApiClient
AsBody
Sends the argument annotated with AsBody as string or bytes in http request. [...]
AsForm
Sends the argument annotated with AsForm as url-encoded-form body in the http request. Uses ApiClient.serializers for serialization. [...]
AsFormField
Sends the argument annotated with AsFormField as a field in url-encoded-form body in the http request. [...]
AsJson
Sends the argument annotated with AsJson as JSON body in the http request. Uses ApiClient.serializers for serialization. [...]
AsMultipart
Sends the argument annotated with AsMultipart as multipart/form-data body in the http request. Uses ApiClient.serializers for serialization if serialize is true. [...]
AsMultipartField
Sends the argument annotated with AsMultipartField as multipart/form-data body field in the http request. [...]
AsyncResponse<BT>
AsyncStringResponse
AsyncTResponse<BT>
BearerToken
BodyAnnotation
CookieJar
Delete
Build fluent REST DELETE APIs [...]
DeleteReq
ErrorResponse
GenApiClient
Get
Build fluent REST GET APIs [...]
GetReq
HeaderMap
HeadReq
HookHeader
Interceptor
Multipart
MultipartFile
MultipartStreamFile
MultipartString
MultipartStringFile
OptionsMethod
Build fluent REST DELETE APIs [...]
Patch
Build fluent REST PATCH APIs [...]
PatchReq
PathParam
Sends the argument annontated with PathParam as path parameter in the http request. [...]
Post
Build fluent REST POST APIs [...]
PostReq
Put
Build fluent REST PUT APIs [...]
PutReq
QueryMap
Sends the Map<String, dynamic> argument annotated with QueryMap as query parameters in the http request. [...]
QueryParam
Sends the argument annotated with QueryParam as query parameter in the http request. [...]
Req
Response<T>
Route
Build fluent REST APIs routes [...]
RouteBase
RouteFetch
RouteWithBody
Serialized
Sends the argument annotated with Serialized as string or bytes in http request. [...]
StringResponse
TResponse<BT>

Properties

globalClient BaseClient
read / write
isUnauthorized Checker<Response>
read-only
mimeTypeIsHtml Checker<Response>
final
mimeTypeIsJson Checker<Response>
final

Functions

bodyBytesIs(List<int> expected) Checker<Response>
bodyIs<T>(T expected, [ bool isEqual(T a, T b) ]) Checker<Response<T>>
delete(String url) Delete
encodingIs(String expected) Checker<Response>
get(String url) Get
headersHas(String header, [ String value ]) Checker<Response>
mimeTypeIs(String expected) Checker<Response>
options(String url) OptionsMethod
patch(String url) Patch
post(String url) Post
put(String url) Put
route(String url) Route
statusCodeIs(int expected) Checker<Response>
statusCodeIsInRange(int lower, int higher) Checker<Response>

Typedefs

After(StringResponse response) → FutureOr
Before(RouteBase route) → FutureOr<void>
Checker<T>(T v) → List<Mismatch>
Performs a check/validation on T
CustomMismatchMessage<T>(T mismatch) → String
Customizes message of a Mismatch
ResponseHook<T>(Response<T> response) → FutureOr
ValueCallback<T>(T value) → void

Exceptions / Errors

EqualityMismatch<T>
MapHasMismatch<T>
Mismatch<M>
A mismatch exception
RangeMismatch<T>