arnihermann/finch

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.

Badges

Modules

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

finch-core - the core classes/functions
finch-argonaut - the JSON API support for the Argonaut library
finch-jackson - the JSON API support for the Jackson library
finch-json4s - the JSON API support for the JSON4S library
finch-circe - the JSON API support for the Circe 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.8.0"
)

for the SNAPSHOT version:

resolvers += Resolver.sonatypeRepo("snapshots")

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

Hello World!

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

import io.finch.route._
import com.twitter.finagle.Httpx

val api: Router[String] = get("hello") { "Hello, World!" }

Httpx.serve(":8080", api.toService)

Demo

The petstore project implements the Petstore Swagger example.

Documentation

A comprehensive documentation may be found in the docs/ folder
The latest Scaladoc is available at http://finagle.github.io/finch/docs

Adopters

[Despegar] (http://www.despegar.com)
[Globo.com] (http://globo.com)
Konfettin
JusBrasil
Sabre Labs
Spright
[SoFi] (https://www.sofi.com/)
[Qubit] (http://www.qubit.com)
Submit a pull-request to include your company/project into the list

Contributing

There are plenty of ways to contribute into Finch:

Give it a star
Join the Gitter room and leave a feedback or help with answering users' questions
Submit a PR (there is an issue label "easy" for newcomers)
Be cool and wear a Finch T-Shirt

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.

arnihermann / finch