Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/twitter/finatra

Fast, testable, Scala services built on TwitterServer and Finagle
https://github.com/twitter/finatra

finagle framework guice http microservices scala slf4j testing thrift twitter-server

Last synced: 20 days ago
JSON representation

Fast, testable, Scala services built on TwitterServer and Finagle

Host: GitHub
URL: https://github.com/twitter/finatra
Owner: twitter
License: apache-2.0
Created: 2012-02-16T23:55:29.000Z (over 12 years ago)
Default Branch: develop
Last Pushed: 2024-05-07T20:18:06.000Z (6 months ago)
Last Synced: 2024-10-01T15:40:17.113Z (about 1 month ago)
Topics: finagle, framework, guice, http, microservices, scala, slf4j, testing, thrift, twitter-server
Language: Scala
Homepage: https://twitter.github.io/finatra/
Size: 31.9 MB
Stars: 2,273
Watchers: 213
Forks: 406
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-scala - **finatra** - activity/y/twitter/finatra) (Table of Contents / Web Frameworks)

README

        # Finatra

[![Build Status](https://github.com/twitter/finatra/workflows/continuous%20integration/badge.svg?branch=develop)](https://github.com/twitter/finatra/actions?query=workflow%3A%22continuous+integration%22+branch%3Adevelop)

[![Project status](https://img.shields.io/badge/status-active-brightgreen.svg)](#status)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.twitter/finatra-http-server_2.12/badge.svg)][maven-central]

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/twitter/finatra)

## Status

This project is used in production at Twitter (and many other organizations),

and is being actively developed and maintained.



Finatra is a lightweight framework for building fast, testable, scala applications on top of [TwitterServer][twitter-server] and [Finagle][finagle]. Finatra provides an easy-to-use API for creating and [testing](https://twitter.github.io/finatra/user-guide/testing/index.html) [Finagle servers](https://twitter.github.io/finagle/guide/Servers.html) and [apps](https://twitter.github.io/util/docs/#com.twitter.app.App) as well as powerful JSON support, modern logging via [SLF4J][slf4j], [Finagle client](https://twitter.github.io/finagle/guide/Clients.html) utilities, and more.

## Getting involved

* Website: [https://twitter.github.io/finatra/](https://twitter.github.io/finatra/)

* Latest news: [Blog](https://finagle.github.io/blog/)

* Github Source: [https://github.com/twitter/finatra/](https://github.com/twitter/finatra/)

* Gitter: [https://gitter.im/twitter/finatra](https://gitter.im/twitter/finatra)

* Mailing List: [[email protected]](https://groups.google.com/forum/#!forum/finatra-users)

## Features

* Production use [@Twitter](https://twitter.com/).

* ~50 times faster than v1.6 in several benchmarks.

* Powerful Feature and Integration test support.

* Optional JSR-330 Dependency Injection using [Google Guice][guice].

* [Jackson][jackson]-based JSON parsing supporting required fields, default values, and [validations](https://twitter.github.io/finatra/user-guide/json/validations.html).

* [Logback][logback] [MDC][mdc] integration with [com.twitter.util.Local][local] for contextual logging across [futures](https://twitter.github.io/util/guide/util-cookbook/futures.html).

## Documentation

To get started, see the [Getting Started](https://twitter.github.io/finatra/user-guide/index.html#getting-started) section of our [User Guide][user-guide] to get up and running. Or check out the specific sections for building [HTTP](https://twitter.github.io/finatra/user-guide/http/server.html) or [Thrift](https://twitter.github.io/finatra/user-guide/thrift/server.html) servers.

## Examples

An HTTP controller and server:

```scala

import com.twitter.finatra.http._

@Singleton

class ExampleController extends Controller {

  get("/") { request: Request =>

    "
Hello, world!"

  }

}

```

```scala

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:

```scala

import com.twitter.finatra.thrift._

import com.twitter.scrooge.{Request, Response}

@Singleton

class ExampleThriftController

  extends Controller(MyThriftService) {

  handle(MyFunction).withFn { request: Request[MyFunction.Args] =>

    ...

  }

}

```

```scala

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][sbt] build and are thus buildable as part of the entire project.

Please take a look through the [examples](/examples) for more detailed information on features, testing, building, and running.

## Latest version

The [release branch](https://github.com/twitter/finatra/tree/release) in Github tracks the latest stable [release](https://github.com/twitter/finatra/releases), which is currently:

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.twitter/finatra-http_2.12/badge.svg)][maven-central]

available on Maven Central. See the [First Steps](https://twitter.github.io/finatra/user-guide/getting-started/basics.html#first-steps) section in the [User Guide][user-guide] for how to add dependencies.

Releases are done on an approximately monthly schedule. While

[semver](https://semver.org/) is not followed, the

[changelogs](CHANGELOG.rst) are detailed and include sections on public API

breaks and changes in runtime behavior.

## Development version

The [develop branch](https://github.com/twitter/finatra/tree/develop) 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](https://help.github.com/articles/creating-a-pull-request/).

We feel that a welcoming community is important and we ask that you follow Twitter's [Open Source Code of Conduct](https://github.com/twitter/.github/blob/main/code-of-conduct.md) in all interactions with the community. For more information on providing contributions, please see our [CONTRIBUTING.md](/CONTRIBUTING.md) documentation.

## Presentations

Check out our list of presentations: [Finatra Presentations](https://twitter.github.io/finatra/presentations/).

## Authors

* Steve Cosenza 

* Christopher Coco 

A full list of [contributors](https://github.com/twitter/finatra/graphs/contributors?type=a) can be found on GitHub.

Follow [@finatra](https://twitter.com/finatra) on Twitter for updates.

## License

Copyright 2013 Twitter, Inc.

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

[twitter-server]: https://github.com/twitter/twitter-server

[finagle]: https://github.com/twitter/finagle

[util-app]: https://github.com/twitter/util/tree/release/util-app

[guice]: https://github.com/google/guice

[jackson]: https://github.com/FasterXML/jackson

[logback]: https://logback.qos.ch/

[slf4j]: https://www.slf4j.org/manual.html

[local]: https://github.com/twitter/util/blob/release/util-core/src/main/scala/com/twitter/util/Local.scala

[mdc]: https://logback.qos.ch/manual/mdc.html

[maven]: https://maven.apache.org/

[maven-central]: https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.twitter%22%20AND%20%28a%3A%22finatra-http_2.12%22%20OR%20a%3A%22finatra-thrift_2.12%22%29

[user-guide]: https://twitter.github.io/finatra/user-guide/index.html

[sbt]: https://www.scala-sbt.org/