Best Practices

HTTP

The GraphQL API for huslejenaevn.dk is served over HTTPS via a single endpoint which expresses the full set of capabilities of the service. This makes it easy to use tools such as GraphiQL, Strawberry Shake and others.

JSON

The GraphQL API for huslejenaevn.dk respond using JSON and supports use of compression with Accept-Encoding HTTP header. Both Gzip and Brotli are supported and we encourage clients to send the header:

Accept-Encoding: br, gzip

Versioning

The GraphQL API for huslejenaevn.dk is not versioned and only returns the data that is explicitly requested, so new capabilities can be added via new types and new fields on those types without creating a breaking change.

Nullability

The GraphQL API for huslejenaevn.dk applies that every field is nullable by default.

Pagination

The GraphQL API for huslejenaevn.dk exposes specific query object used for paging based on the Connection Pattern. See Queries.