Deploy Graphman + File Server
GraphQL API collection generator service using Graphman and Flask.
graphman-cron
Just deployed
file-server
Just deployed
/data
GraphQL API Collection Generator and Server
This repo contains two components which allow Railway to distribute the GraphQL API collection for Railway's public API.
We have captured this in a template for Railway users to deploy, should they find it useful.
Components
1. file-server/
A Flask application with the following routes:
- /upload (POST): Accepts a JSON body which is compared against the current collection file to be stored in
/dataif any changes are detected. - / (GET): Renders a simple File Explorer of the
/datadirectory and allows for downloading the existing collection file. An archive directory also exists to store old versions of the file.
2. graphman/
A modified version of the Graphman CLI. It runs on a cron schedule defined in graphman/railway.toml. It is responsible for:
- Generating the GraphQL API collection.
- Sending a POST request to the
file-server/uploadendpoint with the GraphQL API collection object.
Environment Variables
The Graphman component expects two environment variables. Both are preconfigured in the Railway template, as follows -
- API_URL=
${{file-server.RAILWAY_PUBLIC_DOMAIN}}(URL of the file server) - GRAPHQL_ENDPOINT=
https://backboard.railway.app/graphql/v2(GraphQL API endpoint from which to generate a colection)
Note: If using this service to generate a collection from another GraphQL API, keep in mind that some API's may have authentication requirements that will require a modification of the Graphman cron. Refer to the Graphman Documentation for more information.
Template Content
graphman-cron
railwayapp-templates/graphman-plus-serverfile-server
railwayapp-templates/graphman-plus-server