Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apollographql/federation-demo
Federation 2 supersedes this demo and this example is no longer the newest. See https://www.apollographql.com/docs/federation/ for migration steps!
https://github.com/apollographql/federation-demo
Last synced: 3 months ago
JSON representation
Federation 2 supersedes this demo and this example is no longer the newest. See https://www.apollographql.com/docs/federation/ for migration steps!
- Host: GitHub
- URL: https://github.com/apollographql/federation-demo
- Owner: apollographql
- License: mit
- Archived: true
- Created: 2019-05-24T04:36:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-26T19:49:14.000Z (over 1 year ago)
- Last Synced: 2024-08-01T12:31:50.902Z (6 months ago)
- Language: JavaScript
- Homepage: https://www.apollographql.com/docs/federation/
- Size: 1.14 MB
- Stars: 502
- Watchers: 65
- Forks: 200
- Open Issues: 43
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - federation-demo
- awesome-starred - apollographql/federation-demo - Federation 2 supersedes this demo and this example is no longer the newest. See https://www.apollographql.com/docs/federation/ for migration steps! (others)
README
# Archival
This repo was archived by the Apollo Security team on 2023-05-26
## Apollo Federation Demo
This repository is a demo of using Apollo Federation to build a single schema on top of multiple services. The microservices are located under the [`./services`](./services/) folder and the gateway that composes the overall schema is in the [`gateway.js`](./gateway.js) file.
### Installation
To run this demo locally, pull down the repository then run the following commands:
```sh
npm install
```
This will install all of the dependencies for the gateway and each underlying service.
```sh
npm run start-services
```
This command will run all of the microservices at once. They can be found at http://localhost:4001, http://localhost:4002, http://localhost:4003, and http://localhost:4004.
In another terminal window, run the gateway by running this command:
```sh
npm run start-gateway
```
This will start up the gateway and serve it at http://localhost:4000
### What is this?
This demo showcases four partial schemas running as federated microservices. Each of these schemas can be accessed on their own and form a partial shape of an overall schema. The gateway fetches the service capabilities from the running services to create an overall composed schema which can be queried.
To see the query plan when running queries against the gateway, click on the `Query Plan` tab in the bottom right hand corner of [GraphQL Playground](http://localhost:4000)
To learn more about Apollo Federation, check out the [docs](https://www.apollographql.com/docs/apollo-server/federation/introduction)