Finch is a thin layer of purely functional basic blocks atop of Finagle for building composable REST APIs. Its mission is to provide the developers simple and robust REST API primitives being as close as possible to the bare metal Finagle API.

Modules

Finch uses multi-project structure and contains of the following modules:

• finch-core - the core classes/functions
• finch-json - the lightweight and immutable JSON API
• finch-demo - the demo project
• finch-jawn - the JSON API support for the Jawn library
• finch-argonaut - the JSON API support for the Argonaut library
• finch-jackson - the JSON API support for the Jackson library

Installation

Every Finch module is published at Maven Central. Use the following sbt snippet ...

• for the stable release:

libraryDependencies ++= Seq(
  "com.github.finagle" %% "[finch-module]" % "0.4.0"
)

• for the SNAPSHOT version:

resolvers += Resolver.sonatypeRepo("snapshots")

libraryDependencies ++= Seq(
  "com.github.finagle" %% "[finch-module]" % "0.5.0-SNAPSHOT" changing()
)

Hello World!

This "Hello World!" example is built with the 0.5.0-SNAPSHOT version of finch-core.

Httpx.serve(":8080", Get / "hello" / string /> Ok("Hello " + _ + "!").toFuture)

Documentation

• A comprehensive documentation may be found in the docs.md file in the root directory
• The latest Scaladoc is here

Contacts

• Use a Gitter room for questions like "How do I ..."

Adopters

• Konfettin
• JusBrasil
• Sabre Labs
• Submit a pull-request to include your company/project into the list

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---