Skip to content
Fast, testable, Scala services built on TwitterServer and Finagle
Branch: develop
Clone or download
vkostyukov and jenkins csl: Release CSL libraries 19.5
It's a release day. Let's cut a May release.

JIRA Issues: CSL-8130

Differential Revision: https://phabricator.twitter.biz/D315909
Latest commit 9f2a2ce May 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Twitter OSS: Add ISSUE_TEMPLATE Jul 7, 2016
benchmarks finatra: URL-decode route params automatically May 7, 2019
doc/src/sphinx finatra-http: Address HttpWarmup utility May 17, 2019
examples finatra-http: Address HttpWarmup utility May 17, 2019
http finatra-http: Address HttpWarmup utility May 17, 2019
httpclient finatra: Remove commons-io as a dependency May 15, 2019
inject-thrift-client-http-mapper finatra-http: Replace 'routeToAdminServer' with 'RouteHint' May 14, 2019
inject finatra-http: Address HttpWarmup utility May 17, 2019
jackson finatra-jackson: Properly account for TZ in JodaDatetimeDeserializer May 10, 2019
kafka-streams finatra-kafka: Stop using jodatime May 16, 2019
kafka finatra-kafka: Stop using jodatime May 16, 2019
project csl: Release CSL libraries 19.5 May 17, 2019
thrift finatra-http: Address HttpWarmup utility May 17, 2019
utils finatra: Remove commons-io as a dependency May 15, 2019
.gitignore all: Audit gitignore Contents May 8, 2019
.travis.yml finatra: Use Scala 2.12.8 in build.sbt and Travis CI Mar 26, 2019
ADOPTERS.md Add Fitbit to ADOPTERS.md Apr 6, 2017
CHANGELOG.rst csl: Release CSL libraries 19.5 May 17, 2019
CONTRIBUTING.md finatra: Use HTTPS URLs Apr 15, 2019
LICENSE Add and update files for open-repository Apr 29, 2015
README.md csl: Release CSL libraries 19.5 May 17, 2019
build.sbt csl: Release CSL libraries 19.5 May 17, 2019
finatra_logo.png Added transparent logo and updated README.md May 14, 2015
finatra_logo_text.png finatra - Update logo image Aug 17, 2016
pushsite.bash csl: Updated pushsites scripts for sbt 1.0.x Nov 10, 2017
sbt twitter-oss: Revert sbt update to 1.2.8 Apr 2, 2019

README.md

Finatra

Build Status Test Coverage Project status Maven Central Gitter

Status

This project is used in production at Twitter (and many other organizations), and is being actively developed and maintained.

Finatra Logo

Finatra is a lightweight framework for building fast, testable, scala applications on top of TwitterServer and Finagle. Finatra provides an easy-to-use API for creating and testing Finagle servers and apps as well as powerful JSON support, modern logging via SLF4J, Finagle client utilities, and more.

Getting involved

Features

Documentation

To get started, see the Getting Started section of our User Guide to get up and running. Or check out the specific sections for building HTTP or Thrift servers.

Examples

An HTTP controller and server:

import com.twitter.finatra.http._

@Singleton
class ExampleController extends Controller {
  get("/") { request: Request =>
    "<h1>Hello, world!</h1>"
  }
}
import com.twitter.finatra.http._

class ExampleServer extends HttpServer {
  override def configureHttp(router: HttpRouter): Unit = {
    router
      .filter[CommonFilters]
      .add[ExampleController]
  }
}

A Thrift controller and server:

import com.twitter.finatra.thrift._

@Singleton
class ExampleThriftController 
  extends Controller
  with MyThriftService.BaseServiceIface {
  
  override val myFunction = handle(MyFunction) { args: MyFunction.Args =>
    ...
  }
}
import com.twitter.finatra.thrift._

class ExampleServer extends ThriftServer {
  override def configureThrift(router: ThriftRouter): Unit = {
    router
      .add[ExampleThriftController]
  }
}

Example Projects

Finatra includes working examples which highlight various features of the framework and include tests. These examples are included in the root sbt build and are thus buildable as part of the entire project.

Please take a look through the examples for more detailed information on features, testing, building, and running.

Latest version

The master branch in Github tracks the latest stable release, which is currently:

Maven Central

available on Maven Central. See the First Steps section in the User Guide for how to add dependencies.

Releases are done on an approximately monthly schedule. While semver is not followed, the changelogs are detailed and include sections on public API breaks and changes in runtime behavior.

Development version

The develop branch in Github tracks the latest code which is updated every week. If you want to contribute a patch or fix, please use this branch as the basis of your Pull Request.

For more information on providing contributions, please see our CONTRIBUTING.md documentation.

Presentations

Check out our list of presentations: Finatra Presentations.

Authors

A full list of contributors can be found on GitHub.

Follow @finatra on Twitter for updates.

License

Copyright 2013-2018 Twitter, Inc.

Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0

You can’t perform that action at this time.