GraphQL

Endpoint

Our GraphQL endpoint is available at https://api.fairu.app/graphql.

Schema

To download the schema for Fairu, make a GET request to:

https://api.fairu.app/schema.graphql

For detailed documentation and to test queries interactively, visit our GraphQL Playground.

Naming conventions

To allow this endpoint to be integrated into a GraphQL Router (like Apollo Router) based on GraphQL Federation, we prefix our queries and types with "fairu", e.g.:

query HealthCheck {
  fairuHealthCheck {
    version
    healthy
  }
}

An exception to the prefix rule are mutations. However, they will always contain "fairu" within the name.

Federation

Every type provides Entities, which allows you to store only the ID of our entity and let the rest be resolved by our service. This enables seamless integration with your federated GraphQL architecture.