Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spotify/apollo
Java libraries for writing composable microservices
https://github.com/spotify/apollo
framework http-server java java-8
Last synced: about 2 months ago
JSON representation
Java libraries for writing composable microservices
- Host: GitHub
- URL: https://github.com/spotify/apollo
- Owner: spotify
- License: apache-2.0
- Archived: true
- Created: 2015-11-05T22:40:39.000Z (about 9 years ago)
- Default Branch: 1.x
- Last Pushed: 2021-09-28T09:11:26.000Z (about 3 years ago)
- Last Synced: 2024-09-21T15:50:50.391Z (about 2 months ago)
- Topics: framework, http-server, java, java-8
- Language: Java
- Homepage: http://spotify.github.io/apollo/
- Size: 2.73 MB
- Stars: 1,647
- Watchers: 120
- Forks: 209
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-cloud-native-java - Apollo
README
Apollo
======
[](https://circleci.com/gh/spotify/apollo)
[](https://codecov.io/gh/spotify/apollo)
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.spotify%22%20apollo*)
[](LICENSE.txt)
## Status: Archived
> ⚠️ Apollo is heavily used within Spotify, however, most of its development has recently been done internally leveraging Apollo's module system. Because of this, and the fact that Apollo has very little (if any) use outside Spotify we want to signal this current state to the community by putting the project in archive mode. This means this project will no longer have new features, bug fixes or accept PRs for new features. Apollo development will continue internally in Spotify.
Apollo is a set of Java libraries that we use at Spotify when writing microservices. Apollo includes modules such as an HTTP server and a URI routing system, making it trivial to implement restful API services.
Apollo has been used in production at Spotify for a long time. As a part of the work to release version 1.0.0 we moved the development of Apollo into the open.
There are two main libraries in Apollo:
* [apollo-api](apollo-api)
* [apollo-core](apollo-core)
### Apollo API
The [apollo-api](apollo-api) library is the Apollo library you are most likely to interact with.
It gives you the tools you need to define your service routes and your request/reply handlers.
Here, for example, we define that our service will respond to a GET request on the path `/` with
the string `"hello world"`:
```java
public static void init(Environment environment) {
environment.routingEngine()
.registerAutoRoute(Route.sync("GET", "/", requestContext -> "hello world"));
}
```
> Note that, for an Apollo-based service, you can see the routes defined for a service by querying
[`/_meta/0/endpoints`](apollo-api-impl/src/main/java/com/spotify/apollo/meta/model).
The apollo-api library provides several ways to help you define your request/reply handlers.
You can specify how responses should be serialized (such as JSON). Read more about
this library in the [Apollo API Readme](apollo-api).
### Apollo Core
The [apollo-core](apollo-core) library manages the lifecycle (loading, starting, and stopping) of
your service. You do not usually need to interact directly with apollo-core; think of it merely
as "plumbing". For more information about this library, see the [Apollo Core Readme](apollo-core).
### Apollo Test
In addition to the two main Apollo libraries listed above, to help you write tests for your
service we have an additional library called [apollo-test](apollo-test). It has helpers to set up
a service for testing, and to mock outgoing request responses.
### Links
[Introduction Website](https://spotify.github.io/apollo)
[JavaDocs](https://spotify.github.io/apollo/maven/apidocs)
[Maven site](https://spotify.github.io/apollo/maven)
### Diagrams
[](website/source/set-up.svg)
[](website/source/runtime.svg)
## Code of conduct
This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
[code-of-conduct]: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md