Comment utiliser SWAG pour gérer les paramètres de demande JSON à Golang?

Traiter efficacement les paramètres de demande JSON à Golang en utilisant Swag

Cet article explore comment combiner Swag Tools dans Golang Project pour traiter gracieusement les paramètres de demande JSON et générer une documentation API claire. De nombreux développeurs sont souvent confus sur la façon d'annoter correctement les paramètres de demande JSON lors de l'utilisation de SWAG. Cet article répondra en détail à cette question et fournira un exemple complet de code.

Tout d'abord, afin d'annoter correctement les paramètres de demande JSON dans SWAG, nous devons utiliser l'annotation @param . Supposons que notre point de terminaison API doit recevoir un corps de demande au format JSON, la méthode d'annotation Swag correcte est la suivante:

 // @param body myRequestData

Ce commentaire indique à Swag que le point final reçoit un paramètre JSON nommé myRequestData , dont la source de données est le corps. myRequestData doit être remplacé par votre nom de structure réel.

Ensuite, recevez et traitez ce corps de demande JSON dans le code Golang, les étapes sont les suivantes:

1. Lisez le corps de la demande: utilisez Body de l'objet http.Request pour lire le contenu du corps de la demande.
2. Désérialisation JSON: utilisez la fonction Unmarshal du package encoding/json pour désérialiser les données JSON Read dans la structure Golang correspondante.

L'exemple de code complet est le suivant:

 package principal

importer (
    "Encodage / JSON"
    "Io"
    "net / http"
)

// myRequestData définit la structure qui reçoit le type de données JSON MyRequestData struct {
    Nom String `JSON:" Name "`
    Âge Int `JSON:" Age "`
}

func myhandler (w http.ResponseWriter, r * http.request) {
    // Lire le corps du corps de la demande, err: = io.readall (R.Body)
    Si err! = Nil {
        http.error (w, err.error (), http.statusbadrequest)
        Retour
    }
    Déférer r.body.close () // N'oubliez pas de fermer le corps de la demande // désérialiser les données JSON Var Données MyRequestData
    err = json.unmarshal (corps et données)
    Si err! = Nil {
        http.error (w, err.error (), http.statusbadrequest)
        Retour
    }

    // Traitement des données ...
    // par exemple: fmt.printf ("nom:% s, âge:% ​​d \ n", data.name, data.age)
}

func main () {
    http.handlefunc ("/ myendpoint", myHandler)
    http.ListenandServe (": 8080", nil)
}

Dans cet exemple, la structure myRequestData définit la structure de données que nous prévoyons de recevoir du corps de la demande JSON. json:"name" et json:"age" Assurez la cartographie correcte des champs JSON aux champs de structure Golang. Le code contient la gestion des erreurs nécessaires pour assurer la robustesse du programme. N'oubliez pas d'appeler r.Body.Close() Après avoir traité le corps de la demande, fermez le corps de la demande.

Grâce aux étapes ci-dessus, vous pouvez utiliser efficacement SWAG pour générer des documents d'API et traiter correctement les paramètres de demande JSON dans le code Golang, améliorant ainsi l'efficacité de développement et la qualité du code. Veuillez modifier la structure myRequestData et le traitement de la logique en fonction de vos besoins réels.

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!