Tutoriel pour apprendre à construire et structurer une API GraphQL en Go

Vincent Composieux

GraphQL est disponible depuis maintenant presque deux ans et les applications qui l'utilisent se font toujours assez rares. Pourtant, cette implémentation proposée par Facebook offre de nombreuses possibilités que ne permet pas une API REST.

L'objectif de ce tutoriel n'est pas de vous expliquer ce qu'est GraphQL, la documentation située à l'adresse http://graphql.org/learn l'explique déjà très bien !

Je me suis donc intéressé à construire une API GraphQL, et tant qu'à avoir une API performante, j'ai choisi le langage Go pour la développer, à l'aide de la bibliothèque graphql-go.

Commentez

- Titre : Tutoriel pour apprendre à construire et structurer une API GraphQL en Go

- Auteur : Vincent Composieux

- Parution : 22 octobre 2017

- Licence : Copyright ® 2017 Vincent Composieux. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Structure de fichiers de notre API

- II. Point d'entrée de l'API

- III. Structures de données

- IV. Requêtes

- V. Ajouter des relations à votre API

- VI. Effectuer des appels à votre API

- VII. Mutations

- VIII. Sécurité

- IX. Conclusion

- X. Remerciements

I - Structure de fichiers de notre API

La première chose (et pas des moindres) à prendre en compte lorsque l'on souhaite développer une application est la structure de celle-ci.

En effet, notre API va être amenée à évoluer, nous allons avoir de plus en plus d'éléments à fournir à nos applications et peut-être allons-nous souhaiter ajouter des composants (pour sécuriser notre API, pour logger (enregistrer) des informations, pour limiter le nombre de requêtes, etc.).

Ainsi, voici l'arborescence que je vous propose pour notre API :

.
├── app
│   ├── config.go
│   ├── config.json
│   └── config_test.go
├── security
│   ├── security.go
│   └── security_test.go
├── mutations
│   ├── mutations.go
│   ├── mutations_test.go
│   ├── user.go
│   └── user_test.go
├── queries
│   ├── queries.go
│   ├── queries_test.go
│   ├── user.go
│   └── user_test.go
├── types
│   ├── role.go
│   ├── role_test.go
│   ├── user.go
│   └── user_test.go
└── main.go

Nous retrouvons ici :

- app/ qui comprendra tout ce qui sera nécessaire à notre application (API), principalement un fichier de configuration (JSON) config.json ainsi que le fichier Go permettant de charger ce JSON ;

- security/ permettra de regrouper les classes liées à la sécurisation de notre API ;

- mutations/ permettra de regrouper toutes les mutations GraphQL (modifications de données) ;

- queries/ permettra de regrouper toutes les requêtes GraphQL de sélection de données ;

- types/ permettra de regrouper les structures Go utilisées lors de nos mutations ou requêtes.

Enfin, nous retrouvons bien sûr à la racine main.go qui est le point d'entrée de notre API. Nous allons d'ailleurs commencer dès maintenant à construire notre API !

II - Point d'entrée de l'API

Pour construire notre API, nous allons avoir besoin dans un premier temps d'importer le package « net/http » (car notre API GraphQL va être distribuée en HTTP) ainsi que les bibliothèques graphql-go :

1. package main

3. import (

4. "log"

5. "net/http"

6. "github.com/graphql-go/graphql"

7. "github.com/graphql-go/handler"

8. )

10. func main() {

11. // Todo: Implement GraphQL handler

12. http.Handle("/", httpHandler)

13. log.Print("ready: listening...\n")

14. http.ListenAndServe(":8383", nil)

15. }

Vous remarquerez ici qu'il nous manque la variable httpHandler, qui sera en fait le handler HTTP GraphQL qui sera exécuté pour chaque requête sur « / ». Aussi, nous précisons ici que nous allons écouter sur le port 8383, libre à vous de mettre celui que vous souhaitez.

Notre httpHandler va avoir besoin d'un schéma dans lequel nous allons spécifier deux points d'entrée : un pour les requêtes et un second pour les mutations :

1. schemaConfig := graphql.SchemaConfig{

2. Query: graphql.NewObject(graphql.ObjectConfig{

3. Name:   "RootQuery",

4. Fields: queries.GetRootFields(),

5. }),

6. Mutation: graphql.NewObject(graphql.ObjectConfig{

7. Name:   "RootMutation",

8. Fields: mutations.GetRootFields(),

9. }),

10. }

12. schema, err := graphql.NewSchema(schemaConfig)

14. if err != nil {

15. log.Fatalf("Failed to create new schema, error: %v", err)

16. }

18. httpHandler := handler.New(&handler.Config{

19. Schema: &schema

20. })

Dans le cas où vous n'avez aucune modification de données, mais uniquement des requêtes de sélection, vous pouvez bien sûr supprimer la section concernant les mutations.

Ici, il nous manque queries.GetRootFields() ainsi que mutations.GetRootFields(). Ces méthodes vont nous permettre de définir toutes les queries et mutations que nous allons définir par la suite.

Plutôt que d'alourdir le fichier main.go, j'ai choisi de les déposer sous queries/queries.go et mutations/mutations.go.

III - Structures de données

Avant de commencer à écrire notre première requête, nous devons définir notre modèles de données.

Dans ce tutoriel, nous allons partir sur des données utilisateur (“user”) avec un identifiant, un prénom et un nom. Cela donne pour notre fichier types/user.go :

1. package types

3. import (

4. "github.com/graphql-go/graphql"

5. )

7. // définition du type User.

8. type User struct {

9. ID        int    `db:"id" json:"id"`

10. Firstname string `db:"firstname" json:"firstname"`

11. Lastname  string `db:"lastname" json:"lastname"`

12. }

14. // UserType est le schéma GraphQL pour le type utilisateur.

15. var UserType = graphql.NewObject(graphql.ObjectConfig{

16. Name: "User",

17. Fields: graphql.Fields{

18. "id":         &graphql.Field{Type: graphql.Int},

19. "firstname":  &graphql.Field{Type: graphql.String},

20. "lastname":   &graphql.Field{Type: graphql.String},

21. },

22. })

Nous avons ici défini deux choses :

- une structure Go, qui sera utilisée par notre base de données afin de renvoyer les données de notre API au format JSON ;

- un objet UserType qui sera utilisé par notre API GraphQL afin d'indiquer les champs qui peuvent être retournés aux applications.

À l'aide de ce modèle de données, nous sommes maintenant prêts à construire notre première requête GraphQL !

IV - Requêtes

Commençons par éditer le fichier queries/queries.go afin d'ajouter une requête user qui sera chargée de retourner nos données utilisateur :

1. package queries

3. import (

4. "github.com/graphql-go/graphql"

5. )

7. // GetRootFields retourne toutes les requêtes disponibles.

8. func GetRootFields() graphql.Fields {

9. return graphql.Fields{

10. "user": GetUserQuery(),

11. }

12. }

Nous avons donc ajouté un nouveau champ à notre requête principale écrite précédemment (RootQuery), nommé user et qui fera appel à la fonction GetUserQuery().

Nous allons maintenant définir cette fonction et son comportement dans un fichier dédié sous queries/user.go :

1. package queries

3. import (

4. "../types"

5. "github.com/graphql-go/graphql"

6. )

8. // GetUserQuery renvoie les requêtes disponibles pour le type utilisateur.

9. func GetUserQuery() *graphql.Field {

10. return &graphql.Field{

11. Type: graphql.NewList(types.UserType),

12. Resolve: func(params graphql.ResolveParams) (interface{}, error) {

13. var users []types.User

15. // ... Implémenter la logique de base de données ici

16. return users, nil

17. },

18. }

19. }

Notre première requête est prête : nous allons utiliser le type de données UserType, il ne vous reste plus qu'à implémenter la logique de retour de vos données !

Vous pouvez, à cet endroit , faire un appel à tout outil de stockage de vos données : bases de données relationnelles ou non, SQL ou non, fichier, mémoire, tout est envisageable.

V - Ajouter des relations à votre API

Imaginons maintenant que vous ayez des types roles (pour gérer des accès à certaines ressources) associés à vos utilisateurs.

Vous pouvez également demander à votre API de retourner ceux-ci. Pour cela, nous allons commencer par implémenter une nouvelle structure Role ainsi qu'un nouveau type RoleType pour GraphQL.

Créez donc le fichier types/role.go avec le code suivant :

1. package types

3. import (

4. "github.com/graphql-go/graphql"

5. )

7. // Définition du type Role.

8. type Role struct {

9. ID   int    `db:"id" json:"id"`

10. Name string `db:"name" json:"name"`

11. }

13. // RoleType est le schéma GraphQL pour le type utilisateur.

14. var RoleType = graphql.NewObject(graphql.ObjectConfig{

15. Name: "Role",

16. Fields: graphql.Fields{

17. "id":   &graphql.Field{Type: graphql.Int},

18. "name": &graphql.Field{Type: graphql.String},

19. },

20. })

Voilà qui est fait. Il faut maintenant que nous spécifiions à notre UserType qu'il est possible d'obtenir les roles de l'utilisateur.

Pour cela, éditez le fichier types/user.go et ajoutez une nouvelle section graphql.Field vers votre RoleType:

1. var UserType = graphql.NewObject(graphql.ObjectConfig{

2. Name: "User",

3. Fields: graphql.Fields{

4. // ... champs déjà définis

5. "roles": &graphql.Field{

6. Type: graphql.NewList(RoleType),

7. Resolve: func(params graphql.ResolveParams) (interface{}, error) {

8. var roles []Role

9. // userID := params.Source.(User).ID

10. // Mettre en œuvre la logique pour récupérer les rôles associés aux utilisateurs de cet ID.

11. return roles, nil

12. },

13. },

14. },

15. })

Notez ici que le Type spécifié est un graphql.NewList(RoleType), car nous allons retourner une liste de roles et non pas un seul role.

Pour effectuer votre requête, vous pouvez utiliser params.Source pour obtenir les informations de l'élément principal (ici, l'utilisateur) et ainsi obtenir vos données liées à cet utilisateur.

Enfin, ce qui est intéressant ici est que le requêtage de données (roles) sera effectué uniquement si le client effectuant la requête GraphQL demande à obtenir les roles.

VI - Effectuer des appels à votre API

À partir de là, vous pouvez donc interroger votre API avec la requête suivante :

1. curl

2. -X POST

3. -H 'Content-Type: application/json'

4. -d '{"query": "query { users { id,firstname,lastname,roles{name} } }"}'

5. http://localhost:8383/

7. {"data":{"user":[{"id":1,"firstname":"Vincent","lastname":"COMPOSIEUX","roles":[]}, ...]}}

Bien entendu, uniquement les champs demandés dans la requête vous seront retournés, c'est le principe.

GraphQL offre bien sûr des possibilités intéressantes au niveau des requêtes avec notamment des alias (aliases), variables et fragments qui ne sont pas l'objectif de cet article, mais je vous invite à faire un tour dans la documentation, ça se comprend très simplement facilement :

- Alias

- Fragments

- Variables

VII - Mutations

Côté mutations, le fonctionnement est identique aux requêtes. Nous allons donc créer notre première mutation et vous allez voir que ça ressemble beaucoup aux queries.

Créons le fichier mutations/mutations.go et spécifions notre RootMutation avec notre fonction GetRootFields() :

1. package mutations

3. import (

4. "github.com/graphql-go/graphql"

5. )

7. // GetRootFields renvoie toutes les mutations disponibles.

8. func GetRootFields() graphql.Fields {

9. return graphql.Fields{

10. "createUser": GetCreateUserMutation(),

11. }

12. }

Ici, nous allons créer une mutation pour ajouter un nouvel utilisateur dans notre base de données.

Déclarons donc maintenant la fonction GetCreateUserMutation() dans le fichier mutations/user.go :

1. package mutations

3. import (

4. "../types"

5. "github.com/graphql-go/graphql"

6. )

8. // GetCreateUserMutation crée un nouvel utilisateur et le retourne.

9. func GetCreateUserMutation() *graphql.Field {

10. return &graphql.Field{

11. Type: types.UserType,

12. Args: graphql.FieldConfigArgument{

13. "firstname": &graphql.ArgumentConfig{

14. Type: graphql.NewNonNull(graphql.String),

15. },

16. "lastname": &graphql.ArgumentConfig{

17. Type: graphql.NewNonNull(graphql.String),

18. },

19. },

20. Resolve: func(params graphql.ResolveParams) (interface{}, error) {

21. user := &types.User{

22. Firstname: params.Args["firstname"].(string),

23. Lastname:  params.Args["lastname"].(string),

24. }

26. // Ajout de votre nouvel utilisateur dans la base de données

27. return user, nil

28. },

29. }

30. }

Votre mutation est prête à être utilisée !

Comme vous pouvez le remarquer, nous avons ici ajouté une section Args qui nous permet de définir des arguments pour notre fonction, par exemple : createUser(firstname: "John", lastname: "Snow").

Il est ensuite possible de tester votre API en effectuant la requête HTTP suivante :

1. curl

2. -X POST

3. -H 'Content-Type: application/json'

4. -d '{"query": "mutation { createUser(firstname: \"John\", lastname: \"Snow\") { id,firstname,lastname } }"}'

5. http://localhost:8383

Vous pouvez bien sûr choisir d'obtenir en retour uniquement l'identifiant de l'utilisateur nouvellement créé.

VIII - Sécurité

La plupart de vos API ne sont certainement pas publiques, il vous faut donc y ajouter un composant de sécurité, et c'est ce que nous allons faire ici en intégrant une authentification JWT.

Nous allons utiliser la bibliothèque dgrijalva/jwt-go afin de simplifier l'intégration de JWT dans notre application.

Ajoutez simplement dans votre fichier security/security.go le contenu suivant :

1. package security

3. import (

4. "fmt"

5. "log"

6. "net/http"

7. jwt "github.com/dgrijalva/jwt-go"

8. )

10. // Le middleware de sécurité de Handle vise à implémenter une authentification JWT.

11. func Handle(next http.Handler) http.Handler {

12. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

13. tokenString := r.Header.Get("Authorization")[7:] // 7 corresponds to "Bearer "

14. token, _ := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {

15. if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {

16. return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"])

17. }

19. var secret = "my-high-security-secret" // Prefer to store this secret in a configuration file

20. return []byte(secret), nil

21. })

22. if claims, ok := token.Claims.(jwt.MapClaims); ok && token.Valid {

23. log.Printf("JWT Authenticated OK (app: %s)", claims["app"])

24. next.ServeHTTP(w, r)

25. }

26. })

27. }

Ici, nous récupérons le token (jeton) reçu dans le header Authorization: Bearer xxx et allons l'utiliser pour le comparer avec notre secret.

Dans le cas ou le token est valide, l'application continuera à exécuter le handler HTTP, sinon une erreur sera levée.

Pour utiliser ce composant de sécurité, il faut repasser sur notre fichier main.go afin d'importer le répertoire security et de modifier :

http.Handle("/", httpHandler)

en :

http.Handle("/", security.Handle(httpHandler))

Vous disposez maintenant d'une API GraphQL performante et sécurisée !

IX - Conclusion

L'implémentation de GraphQL en Go est plutôt simple à prendre en main et l'efficacité du langage permet de construire une API performante.

Il nous est également possible de bien structurer celle-ci afin de séparer notamment les queries, les mutations et les autres composants.

Si vous voulez tester cette structure, les sources sont disponibles ici.

X - Remerciements

Nous remercions elevenlabs qui nous a autorisés à publier ce tutoriel.

Nous tenons également à remercier Winjerome pour la mise au gabarit et Jacques Jean pour la correction orthographique.