Implémentation élégante de l'architecture API Golang REST

                                                                                                      

Il y a un dicton selon lequel l'API écrite en Golang ne peut pas être aussi simple et universelle que d'autres langages. Mais en réalité, j'ai rencontré beaucoup de code API REST avec beaucoup d'abstractions, rendant la base de code confuse et complexe, nuisant finalement à la lisibilité et à la maintenabilité.

Dans cette série, nous verrons comment créer une liste TODO d'API REST au niveau du produit, une architecture d'extension durable, en commençant par les interfaces de routage et de code, puis en ajoutant une base de données mongo et une couche de données Badger, et puis est la couche de protocole d'autorisation (OAuth 2.0)

Dans cette série, nous utiliserons le routage chi.

Pourquoi choisir d'utiliser Chi au lieu de la bibliothèque standard ou de Gin ou router-x pour le routage ?

Eh bien, en fait, peu importe ce que vous choisissez d'utiliser. Peu importe ce que vous utilisez pour le routage, les concepts abordés dans cette série vous seront utiles. Mais il y a les avantages suivants qui me font penser que Chi-router est supérieur à la plupart des alternatives :

• et net/http 100 % compatible avec la bibliothèque standard --- disponible dans l'écosystème Go Utilisez n'importe quel paquet http ou middleware compatible net/http 🎜>

• Aucune dépendance externe --- Purely Go 1.7+ stdlib + net / http

• Puissant - -- De nombreuses entreprises l'utilisent, par exemple : Pressly, CloudFlare, Heroku, 99Designs

• Léger --- cloqué en ~ 1000 LOC pour le routeur chi

• C'est rapide

• Ce que j'aime le plus, c'est que les anciens gestionnaires http et middleware que vous avez écrits pour d'autres routeurs compatibles net/http fonctionneront toujours très bien.
  Commençons

Tout d'abord, nous créons un main.go . La base (ou l'élément central ?) de notre programme

Le code ci-dessus est au centre de certaines bonnes pratiques

Utiliser un package séparé Pour implémentez la logique de routage, regroupez-les, puis montez-les :

r.Mount("/api/todo", todo.Routes())

1. Vérifiez l'API afin que vous puissiez mettre à jour l'API sans casser les anciens clients :

router.Route("/v1", .... )

2. Utiliser le middleware comme extension. Le code qui utilise beaucoup de routage est très lourd, en fait, il peut être transformé en middleware de liens, comme : l'autorisation, la configuration des en-têtes de réponse, la compression, les journaux de requêtes, la limitation de débit, etc.

L'auteur (sur la base des problèmes mentionnés par Ajinkya dans les commentaires, je développerai davantage sur la méthode de marche) :

3. Le routage du Chi a une méthode appelée marche. Paramètres reçus par cette méthode :

Un routeur

• Un rappel.

• Chaque rappel Tous Les itinéraires définis seront rappelés et recevront 4 paramètres :

Méthode de définition de l'itinéraire

• Chaîne de l'itinéraire réel

• Processeur (fonction), gère les requêtes pour une route donnée

• Une liste de middleware définis dans une route donnée (le middleware est une fonction relativement simple, qui sera appelée avant le gestionnaire est appelé, ils seront donc utilisés avant le traitement de la demande, l'autorisation, etc.)

• Dans mon cas, je vais simplement interroger les routes et imprimer toutes les routes définies. Cela me donne un aperçu de tous les itinéraires disponibles.
  Ensuite, nous construisons un package de tâches, qui enregistre en fait notre logique de tâches.

Notes

Le package todo a une méthode qui renvoie tous les itinéraires. Ces itinéraires sont écrits dans le fichier main.go. En fait, j'écris généralement ces itinéraires dans un fichier appelé

routes.go,

afin qu'il soit facile à retrouver dans le package

.

• Le gestionnaire a une signature de fonction , ce qui signifie que le gestionnaire n'est pas différent de la façon dont vous écrivez net/http en utilisant la bibliothèque standard.

• Utilisez render.JSON, un wrapper d'encodage/json, qui échappera automatiquement tout le code HTML dans votre réponse JSON et définira le type de contenu sur application/jsonfunc (w http.ResponseWriter,r *http.Request) 

• Êtes-vous intimidé par la facilité avec laquelle c'est ? Vous pouvez voir ce projet sur GitHub https://github.com/tonyalaribe/todoapi/tre....

  Dans notre prochain article de cette série, nous continuerons à prendre en charge la configuration et l'état partagé. La plupart des projets nécessitent généralement une configuration supplémentaire, telle que des connexions à une base de données, etc. Nous en discuterons dans le prochain article.

  Tutoriel recommandé : "Go Tutorial"

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!