Skip to content
Gisila

API reference

gisila exposes four libraries:

Library Import it from Contents
package:gisila/gisila.dart application code The whole runtime and annotation surface, plus the parts of shelf and shelf_router you need.
package:gisila/testing.dart tests only GisilaTestClient, TestResponse, TestAuthenticator.
package:gisila/builder.dart build.yaml only The build_runner entry point.
package:gisila/builder_helpers.dart other generators Build-time helpers (used by gisila_doc).

The pages below cover every exported symbol. Each entry says what the symbol is for and when to reach for it.

Application and bootstrap

Section titled “Application and bootstrap”

GisilaApp · ControllerAttacher · kAppKey · re-exported Request, Response, Handler, Middleware, Pipeline, HijackException, Router and the rest of shelf_router (other exports)

AppConfig

Section titled “AppConfig”

AppConfig · ErrorHandler

Controllers and routing annotations

Section titled “Controllers and routing annotations”

Controller · Route · Get, Post, Put, Patch, Delete, Head, Options · UseRouteConfig · UseMiddleware · Body · Query · Path · Header · parameter binding rules · return values

RouteConfig and the route runtime

Section titled “RouteConfig and the route runtime”

RouteConfig · gisilaRoute · GisilaRouteHandler · guardRequest · GuardResult

RequestContext

Section titled “RequestContext”

RequestContext · CancellationToken · RequestCancelledException · kContextKey, kServiceResolverKey, kSingletonResolverKey, kCancellationKey, kAbandonedWorkKey

Forms and validation

Section titled “Forms and validation”

Form · bindForm · FormField · FieldValidator · StringField · EmailField · PasswordField · IntField · DoubleField · BoolField · DateTimeField · JsonField · FileField · FormValidationException

Request bodies and responses

Section titled “Request bodies and responses”

readBody · readJsonBody · readFormBody · DecodedBody · parseFormData · defaultMaxFormParts · defaultMaxFormFieldBytes · formUrlEncodedContentType · multipartFormDataContentType · FormData · UploadedFile · coerce · jsonResponse · emptyResponse

Services

Section titled “Services”

Service · ServiceFactory

Authentication and permissions

Section titled “Authentication and permissions”

RequireAuth · Public · Permissions · AnyPermission · Roles · Principal · Authenticator · NullAuthenticator · StaticTokenAuthenticator · ApiKeyAuthenticator · ApiKeyLookup · CompositeAuthenticator · PermissionResolver · ClaimsPermissionResolver

JWT

Section titled “JWT”

JwtAuthenticator · JwtSigner · JwtKey · JwtKeySet · StaticJwtKeySet · RemoteJwks · JwtClaims · JwtPrincipalMapper · supportedJwtAlgorithms · minJwtHmacSecretBytes

Middleware

Section titled “Middleware”

pipeline order · CorsConfig · corsMiddleware · RateLimitConfig · rateLimitMiddleware · RateLimitStore · InMemoryRateLimitStore · clientAddress · SecurityHeadersConfig · HstsConfig · securityHeadersMiddleware · CompressionConfig · compressionMiddleware · acceptsGzip · EtagConfig · etagMiddleware · ifNoneMatchHits · requestIdMiddleware · bodySizeLimitMiddleware · limitBytes · allowedContentTypesMiddleware · defaultAllowedContentTypes

Errors

Section titled “Errors”

HttpException · BadRequest, Unauthorized, Forbidden, NotFound, Conflict, PayloadTooLarge, TooManyRequests, InternalServerError · EndpointException · BadRequestException

Logging

Section titled “Logging”

Logger · ConsoleLogger · LogEvent · LogLevel · LogFormat

Database and cache

Section titled “Database and cache”

DatabaseProvider · DbErrorMapper · kDbKey · CacheProvider · InMemoryCacheProvider · kCacheKey

Pagination

Section titled “Pagination”

PageParams · Page · Cursor

Server-sent events and static files

Section titled “Server-sent events and static files”

sseResponse · SseEvent · lastEventId · StaticFilesConfig · staticFilesHandler

Metrics

Section titled “Metrics”

MetricsConfig · metricsMiddleware · kRouteTemplateKey · MetricsRegistry · Counter · Gauge · Histogram · defaultLatencyBuckets · MetricsHub · MetricsHubMember · mergeSnapshots · renderSnapshot

Testing utilities

Section titled “Testing utilities”

GisilaTestClient · TestResponse · TestAuthenticator

Code generation and build.yaml

Section titled “Code generation and build.yaml”

builder configuration · generated code · controllerBuilder · emitRouteConfigLiteral, emitGuardsRouteConfigLiteral, emitNamedMiddlewareConfig · isNullable, typeDisplayName, typeDisplayNameNullable, isCoercible, isShelfRequest, isShelfResponse, isRequestContext, isFormData, isUploadedFile, isFormSubtype, isServiceSubtype, unwrapFuture, isVoid, isStringMap, listElementType, pathPlaceholders, toShelfPath, fromJsonConstructor, fromFormConstructor, isGisilaLibrary, dartString, joinPath, stringSetLiteral