Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eaceto/regraphql
A simple (yet effective) GraphQL to HTTP / REST router
https://github.com/eaceto/regraphql
degraphql graphql graphql-server http http-server kong proxy rest-api reverse-proxy
Last synced: 24 days ago
JSON representation
A simple (yet effective) GraphQL to HTTP / REST router
- Host: GitHub
- URL: https://github.com/eaceto/regraphql
- Owner: eaceto
- License: mit
- Created: 2022-04-05T15:54:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-25T09:45:12.000Z (over 1 year ago)
- Last Synced: 2024-10-15T21:23:58.769Z (about 1 month ago)
- Topics: degraphql, graphql, graphql-server, http, http-server, kong, proxy, rest-api, reverse-proxy
- Language: Go
- Homepage: https://eaceto.dev
- Size: 221 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ReGraphQL
**A simple (yet effective) GraphQL to REST / HTTP router**.
ReGraphQL helps you expose your GraphQL queries / mutations as REST / HTTP endpoints.
Doing this has the following benefits:
* Queries are stored and controlled server side. No queries on the frontend.
* Can modify and optimise your queries on demand without redoploying your (frontend) clients
* Can use GET (HTTP Method) instead of GraphQL's POST
* It's an OSS alternative to [Kong's DeGraphQL](https://marcoam-patch-3--kongdocs.netlify.app/hub/kong-inc/degraphql/)
It helps you going...
**From this**
````graphql
query($person: StarWarsPeople!) {
getPerson(person: $person) {
birthYear
eyeColors
films {
title
}
gender
hairColors
height
homeworld {
name
}
mass
name
skinColors
species {
name
}
starships {
name
}
vehicles {
name
}
}
}
````
**To**
````http request
GET /persons/{person}
````
# Index
* [Requirements](#requirements)
* [Features](#features)
* [Service Endpoints](#service-endpoints)
* [Quick start](#quick-start)
* [Docker Image](#docker-image)
* [Contributing](#contributing)
* [License](#license)
* [Author](#author)
## Requirements
* Go 1.18
## Features
- [x] Maps HTTP params to GraphQL Variables
- [x] Forwards HTTP headers to GraphQL request
- [ ] Set HTTP Status Code different to 200 if GraphQL query fails.
- [ ] Hide GraphQL Error's **Locations**
- [ ] Hide GraphQL Error's **Stacktrace**
- [ ] Hide GraphQL Error's **Path**
- [x] Reads configuration from **.env** file
- [x] Reads configuration from **environment variables**
- [x] Logs using Kubernetes' [**klog**](https://github.com/kubernetes/klog) v2
- [x] Docker Image below 20MB
- [X] Exposes metrics using [Prometheus](https://prometheus.io/)
- [X] Exposes Liveness, Readiness and Startup Probes
## Service Endpoints
### Liveness
````http request
GET /health/liveness
{"hostname":"pod_67804","status":"up"}
````
Returns HTTP Status Code **OK** (200) with the following JSON as soon as the application starts
````json
{"hostname":"<< hostname >>","status":"up"}
````
### Readiness
````http request
GET /health/readiness
{"hostname":"pod_67804","status":"ready"}
````
1. If the application is **Ready** to receive requests
Returns HTTP Status Code **OK** (200) with the following JSON:
````json
{"hostname":"<< hostname >>","status":"ready"}
````
2. If the application is **Not Ready** to receive requests
Returns HTTP Status Code **Precondition Failed** (412) with the following JSON:
````json
{"hostname":"<< hostname >>","status":"waiting"}
````
### Metrics
The service exposes a [Prometheus](https://prometheus.io/) metrics endpoint at **/metrics**
````http request
GET /metrics
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 0
go_gc_duration_seconds{quantile="0.25"} 0
go_gc_duration_seconds{quantile="0.5"} 0
go_gc_duration_seconds{quantile="0.75"} 0
go_gc_duration_seconds{quantile="1"} 0
go_gc_duration_seconds_sum 0
````
## Quick start
1. Describe a route in a file using **yaml**, which matches your HTTP endpoint with your GraphQL endpoint and Query
````yaml
routes:
- http:
uri: '/persons/{person}'
method: GET
graphql:
endpoint: 'https://swapi.skyra.pw/'
query: |
query($person: StarWarsPeople!) {
getPerson(person: $person) {
birthYear
eyeColors
films {
title
}
gender
hairColors
height
homeworld {
name
}
mass
name
skinColors
species {
name
}
starships {
name
}
vehicles {
name
}
}
}
````
*File* **starwars.yml**
2. Copy **starwars.yml** into **/tmp/config**
3. Run the service (using Docker Compose)
````shell
[sudo] docker-compose up
````
4. Query your new HTTP endpoint!
````shell
curl 'http://127.0.0.1:8080/graphql/persons/lukeskywalker' --compressed
````
## Docker Image
Docker image is based on Google's Distroless. The final image is around 11.2MB and packs only the necessary things to run the service.
````shell
docker pull eaceto/regraphql:latest
````
## Contributing
Before contributing to ReGraphQL, please read the instructions detailed in our [contribution guide](CONTRIBUTING.md).
## License
ReGraphQL is released under the MIT license. See [LICENSE](LICENSE) for details.
## Author
Created by [Ezequiel (Kimi) Aceto](https://eaceto.dev).