User’s Guide

Finatra builds on TwitterServer and uses Finagle, therefore it is highly recommended that you familiarize yourself with those frameworks before getting started.

The version of Finatra documented here is version 2.x. Version 2.x is a complete rewrite over v1.x and as such many things are different.

For high-level information about the changes from v1.x see the blog post here.

Finatra at its core is agnostic to the type of service or application being created. It can be used to build anything based on TwitterUtil: c.t.app.App.

For servers, Finatra builds on top of the features of TwitterServer (and Finagle) by allowing you to easily define a Server and controllers (a Service-like abstraction) which define and handle endpoints of the Server. You can also compose Filters either per controller, per route in a controller, or across all controllers.

Getting Started

• First Steps
• Understanding the Codebase
• Application and Server Lifecycle
• Modules
• Binding Annotations
• Flags
• Future Gotchas
• Example Projects

Logging

• Introduction to Logging With Finatra
• Logback

HTTP

• HTTP Server Definition
• Defining HTTP Controllers
• HTTP Requests
• HTTP Responses
• Filtering HTTP Requests
• HTTP Exception Mapping
• HTTP Server Warmup

JSON

• Jackson Integration
• JSON Integration with Routing
• JSON Validation Framework

Files

• Working With Files

Thrift

• Scrooge and Finagle
• Thrift Server Definition
• Defining Thrift Controllers
• Filtering Thrift Requests
• Thrift Exception Mapping
• Thrift Server Warmup

Twitter Server

• TwitterServer Admin HTTP Server

Testing

• Testing With Finatra

V1 Migration FAQ

• FAQ for upgrading from Finatra v1.x to v2.x

Contributing

Finatra is an open source project that welcomes contributions from the greater community. We’re thankful for the many people who have already contributed and if you’re interested, please read the contributing guidelines.

For support feel free to follow and/or tweet at the @finatra Twitter account, post questions to the Gitter chat room, or email the finatra-users Google group: finatra-users@googlegroups.com.