The http4k technical documentation is designed following the Grand Unified Theory of Documentation. The http4k creators firmly believe that API design should be natural and friendly to the user, so the codebase is not heavily commented - you can implement systems using the http4k APIs from your IDE alone.
Regardless of which section you're reading, as much of the code as possible exists in the repository and is built with the rest of http4k in our CI. This makes the code a little more verbose (imports and all), but guarantees that it compiles and lets you navigate around to find where everything comes from.
http4k is a simple toolkit based around several function types, and the ideas behind it are straightforward to grasp. This section conveys the mindset and rationale behind http4k, and lays out each of the main function types used in the toolkit and how they relate to each other.
Read the concepts →New libraries are quickest to learn with a guided path. This section contains step-by-step guides that get you comfortable with how things fit together across each of http4k's main conceptual areas - the first tutorial will get you up and running in no time.
Start a tutorial →The meat of the http4k documentation is in this section, in which you'll find ready made solutions to many common use-cases - whatever you're building, there's probably a recipe for it already. Each recipe contains the required Gradle dependencies, a brief description of the problem, and a fully runnable code example.
Browse how-to guides →In order to "fly like a butterfly and sting like a bee", http4k is heavily modularised. This section contains more detailed technical notes on the capabilities present in each of the http4k modules. It's more of a "what" than a "why".
Open the reference →Contribute a recipe
As a community-driven project, we welcome new or updated recipes to make http4k easier to use. Just follow this Markdown template.
