Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-guild-org/conductor
Conductor is a cutting-edge, open-source GraphQL Gateway, fully compliant with the GraphQL specification and designed to supercharge any API with powerful features and proxy flows.
https://github.com/the-guild-org/conductor
federation fusion gateway graphql proxy rust
Last synced: about 1 month ago
JSON representation
Conductor is a cutting-edge, open-source GraphQL Gateway, fully compliant with the GraphQL specification and designed to supercharge any API with powerful features and proxy flows.
- Host: GitHub
- URL: https://github.com/the-guild-org/conductor
- Owner: the-guild-org
- License: mit
- Created: 2023-06-26T08:48:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-28T15:21:50.000Z (about 2 months ago)
- Last Synced: 2024-09-29T12:05:33.113Z (about 2 months ago)
- Topics: federation, fusion, gateway, graphql, proxy, rust
- Language: Rust
- Homepage: https://the-guild.dev/graphql/gateway
- Size: 4.26 MB
- Stars: 93
- Watchers: 11
- Forks: 3
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://graphql.org/conf/2024/?utm_source=github&utm_medium=conductor&utm_campaign=readme)
> [!IMPORTANT]
> Conductor gateway is still under development, and currently available as alpha.
>
> Please use it with caution. Feedback and Contributions are always welcome!
# Conductor: MIT open-source GraphQL Gateway
[](https://github.com/rust-secure-code/safety-dance/)
Conductor is a cutting-edge, open-source GraphQL Gateway, fully compliant with the GraphQL specification and designed to supercharge any GraphQL API with a number of powerful features and proxy flows. Crafted entirely in Rust, it offers unparalleled performance and a great developer experience, making it an ideal choice for projects requiring advanced GraphQL capabilities.
## Key Features
- **Built with Rust**: Focused on performance and reliability, leveraging Rust's safety and concurrency capabilities.
- **Real open-source**: Conductor is open-source (MIT) and free - and will always be.
- **GraphQL Spec Compliance**: Fully adheres to the GraphQL specification, ensuring reliable and standard-compliant behavior.
- **Advanced Gateway Capabilities**: Serves as a dynamic proxy between GraphQL consumers and servers, enhancing GraphQL runtime with robust plugins for caching, authentication, rate limiting, CORS, persisted queries (trusted documents), and OpenTelemetry.
- **Distributed Schemas**: Seamlessly integrates with Apollo Federation, managing all aspects from query planning to response merging.
- **Extensible Endpoint Configuration**: Allows exposure of multiple GraphQL endpoints from a single instance with configurable plugins per endpoint.
- **VRL (Vector Routing Language) Support**: Offers limitless possibilities for custom logic, plugins, and response transformers.
- **Comprehensive Security & Monitoring**: Built-in support for various authentication methods, authorization, rate limiting, and OpenTelemetry for monitoring.
- **Flexible runtime**: Conductor runs either as a binary (and dockerized), and can also run on the Edge (CloudFlare Worker).
## Configuration Overview
Conductor's configuration can be defined in both YAML and JSON formats. The config file contains several key sections:
- **Server**: Configure the HTTP server settings, including port and host.
- **Logger**: Set up logging levels for Conductor's operations.
- **Sources**: Define the GraphQL sources/endpoints that Conductor will interact with. We support both monolith GraphQL and Federation sources.
- **Endpoints**: Specify the GraphQL endpoints Conductor will expose, including path, source, and plugins.
- **Plugins**: List global plugins that apply to all endpoints, including CORS, authentication, and more.
### Configuration File Example (YAML)
```yaml
server:
port: 9000
logger:
filter: error
sources:
- type: graphql
id: my-source
config:
endpoint: https://my-source.com/graphql
endpoints:
- path: /graphql
from: my-source
plugins:
- type: cors
config:
allowed_origin: "*"
- type: graphiql
```
### Configuration File Example (JSON)
```json
{
"server": {
"port": 9000
},
"logger": {
"filter": "error"
},
"sources": [
{
"type": "graphql",
"id": "my-source",
"config": {
"endpoint": "https://my-source.com/graphql"
}
}
],
"endpoints": [
{
"path": "/graphql",
"from": "my-source",
"plugins": [
{
"type": "cors",
"config": {
"allowed_origin": "*"
}
},
{
"type": "graphiql"
}
]
}
]
}
```
## Running Conductor
Conductor can be ran via the docker image, and it can even be ran via `npx` for quick and convenient usage. It also fully supports running as a WASM on Cloudflare Workers, providing flexibility in deployment options.
```sh
npx @graphql-conductor/bin ./conductor.config.yaml
```
Or, locally:
```sh
cargo run --bin conductor ./conductor.config.json
```
If config is not provided as the first argument, Conductor will try to read `config.json` from the root by default. For more details on setting up and running Conductor, [refer to our documentation](https://the-guild.dev/graphql/gateway).
## Contributions
Contributions, issues and feature requests are very welcome. If you are using this package and fixed
a bug for yourself, please consider submitting a PR!
And if this is your first time contributing to this project, please do read our
[Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md)
before you get started off.
### Code of Conduct
Help us keep Conductor open and inclusive. Please read and follow our
[Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted
from [Contributor Covenant](https://www.contributor-covenant.org/)
### License
[](https://github.com/the-guild-org/conductor/blob/master/LICENSE)
Conductor is open-source software licensed under MIT.