Liking cljdoc? Tell your friends :D

Introduction to gossamer.core

Gossamer is a micro web framework module for Clojure. The gossamer.core module combines the following:

Usage

Since gossamer.core builds upon bract.core and other Bract modules, you may check the provided context and config files for the keys being used. A quickstart usage is as follows:

lein new gossamer myapp
cd myapp

Inspect the generated web application, starting with the README.md file.

Context keys

Context keyValue typeDescription
:gossamer/calfpath-routesvector of mapsCalfpath route maps
:gossamer/route-wrappersvector of fn/FQFNRoute wrapper functions (fn [routes context & more]) -> routes

Config keys

Config keyValue typeDescription
"gossamer.routes.compile.options"mapCompile options for Calfpath routes, see calfpath.route/compile-routes
"gossamer.inner.ping.enabled"booleanAdd inner ping route for latency checks?
"gossamer.inner.ping.endpoint.uris"vector of stringVector of inner ping endpoint URIs
"gossamer.inner.ping.endpoint.body"stringString body for inner ping response
"gossamer.inner.ping.content.type"stringContent type for inner ping body
"app.version"stringApplication version
"app.hostname"stringApplication hostname

Provided default context/config

File nameAvailable to applications asDescription
logback-included.xmlgossamer/core/logback-included.xmlbase Logback config
context.edngossamer/core/context.edndefault inducer context
webapp-context.edngossamer/core/webapp-context.ednstandard webapp context
webapp-context.dev.edngossamer/core/webapp-context.dev.ednDEV mode webapp context
config.edngossamer/core/config.edndefault Gossamer config
config.logback.edngossamer/core/config.logback.ednLogback standard config
config.logback.dev.edngossamer/core/config.logback.dev.ednLogback DEV mode config

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close