Azure / Azure/data-api-builder

Support Relay GraphQL standard

Offen
#965 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
needs discussion rfc
Vorherrschende Sprache
C#
Sterne
1.5k
Forks
370
Ø Merge
3 T. 22 Std.
Gemergte PRs (30 T.)
9

Beschreibung

# Summary
Add support for the Relay GraphQL standard

# Motivation

Relay provides quite a lot of useful features to front-developers and given that fact that it is almost a de-facto standard, it means many libraries can provide implementation so that its usage can be ever easier. This is expected to drive adoption of tools like DAB.

# Functional Specifications

Relay is based on two core GraphQL "best practitices" that needs to be implemented in order to support Relay:

- [Complete Connection Model](https://graphql.org/learn/pagination/#complete-connection-model)
- [Global Object Identification](https://graphql.org/learn/global-object-identification/)

more details on the Relay site:

- [GraphQL Cursor Connections Specification](https://relay.dev/graphql/connections.htm)
- [GraphQL Server Specification](https://relay.dev/docs/guides/graphql-server-specification/)

It should be possible to decide if to generate a Relay-compatible GraphQL schema or use the default one provided by Data API Builder, but setting a dedicated configuration option (in the `runtime` section) in the configuration file.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der Überprüfung des Runtime-Abschnitts der Konfigurationsdatei und der verlinkten GraphQL- und Relay-Spezifikationen für das Complete Connection Model und Global Object Identification. Als erledigt gilt die Aufgabe, wenn eine dedizierte Option ein Relay-kompatibles GraphQL-Schema auswählen kann und dabei das standardmäßige Data API Builder-Schema erhalten bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
graphql
Bereich
api
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.