# finatra
**Repository Path**: xiaobin268/finatra
## Basic Information
- **Project Name**: finatra
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-11
- **Last Updated**: 2020-12-18
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Finatra
[](https://travis-ci.com/twitter/finatra?branch=develop)
[](https://codecov.io/github/twitter/finatra?branch=develop)
[](#status)
[][maven-central]
[](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://twitter.github.io/finatra/blog/archives/)
* 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: [finatra-users@googlegroups.com](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]
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/).
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-2020 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/