How to use Swag to handle JSON request parameters in Golang?

Efficiently process JSON request parameters in Golang using Swag

This article explores how to combine Swag tools in Golang project to gracefully process JSON request parameters and generate clear API documentation. Many developers are often confused about how to correctly annotate JSON request parameters when using Swag. This article will answer this question in detail and provide a complete code example.

First, in order to correctly annotate the JSON request parameters in Swag, we need to use the @param annotation. Suppose our API endpoint needs to receive a request body in JSON format, the correct Swag annotation method is as follows:

// @param body myRequestData

This comment tells Swag that the endpoint receives a JSON parameter named myRequestData , whose data source is the body. myRequestData should be replaced with your actual structure name.

Next, receive and process this JSON request body in Golang code, the steps are as follows:

1. Read the request body: Use Body of the http.Request object to read the request body content.
2. JSON deserialization: Use the Unmarshal function of encoding/json package to deserialize the read JSON data into the corresponding Golang structure.

The complete code example is as follows:

package main

import (
    "encoding/json"
    "io"
    "net/http"
)

// myRequestData defines the structure that receives JSON data type myRequestData struct {
    Name string `json:"name"`
    Age int `json:"age"`
}

func myHandler(w http.ResponseWriter, r *http.Request) {
    // Read the request body body, err := io.ReadAll(r.Body)
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        Return
    }
    defer r.Body.Close() // Remember to close the request body // Deserialize JSON data var data myRequestData
    err = json.Unmarshal(body, &data)
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        Return
    }

    // Processing data...
    // For example: fmt.Printf("Name: %s, Age: %d\n", data.Name, data.Age)
}

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

In this example, the myRequestData structure defines the data structure we expect to receive from the JSON request body. json:"name" and json:"age" ensure the correct mapping of JSON fields to Golang structure fields. The code contains the necessary error handling to ensure the robustness of the program. Remember to call r.Body.Close() after processing the request body, close the request body.

Through the above steps, you can effectively use Swag to generate API documents and correctly process JSON request parameters in Golang code, thereby improving development efficiency and code quality. Please modify the myRequestData structure and processing logic according to your actual needs.

The above is the detailed content of How to use Swag to handle JSON request parameters in Golang?. For more information, please follow other related articles on the PHP Chinese website!