Bagaimana cara menggunakan swag untuk mengendalikan parameter permintaan JSON di Golang?

Parameter permintaan JSON dengan cekap di Golang menggunakan swag

Artikel ini meneroka cara menggabungkan alat swag dalam projek Golang untuk memproses parameter permintaan JSON dengan anggun dan menghasilkan dokumentasi API yang jelas. Ramai pemaju sering keliru tentang bagaimana untuk memberi annotasi parameter permintaan JSON dengan betul apabila menggunakan swag. Artikel ini akan menjawab soalan ini secara terperinci dan memberikan contoh kod lengkap.

Pertama, untuk tepat memberi penjelasan Parameter Permintaan JSON dalam SWAG, kita perlu menggunakan anotasi @param . Katakan titik akhir API kami perlu menerima badan permintaan dalam format JSON, kaedah anotasi swag yang betul adalah seperti berikut:

 // @param badan myrequestdata

Komen ini memberitahu Swag bahawa titik akhir menerima parameter JSON bernama myRequestData , yang sumber datanya adalah badan. myRequestData harus digantikan dengan nama struktur sebenar anda.

Seterusnya, terima dan memproses badan permintaan JSON ini dalam kod Golang, langkah -langkahnya adalah seperti berikut:

1. Baca badan permintaan: Gunakan Body objek http.Request untuk membaca kandungan badan permintaan.
2. JSON Deserialization: Gunakan fungsi Unmarshal pakej encoding/json untuk menghilangkan data JSON baca ke dalam struktur Golang yang sepadan.

Contoh kod lengkap adalah seperti berikut:

 Pakej utama

import (
    "Pengekodan/JSON"
    "io"
    "Net/http"
)

// MyRequestData mentakrifkan struktur yang menerima jenis data JSON MyRequestData struct {
    Nama String `Json:" Nama "`
    Umur int `json:" umur "`
}

Func MyHandler (w http.ResponseWriter, r *http.request) {
    // Baca badan badan permintaan, err: = io.readall (r.body)
    jika err! = nil {
        http.error (w, err.error (), http.statusbadrequest)
        Kembali
    }
    menangguhkan r.body.close () // ingat untuk menutup badan permintaan // deserialize json data var data myRequestData
    err = json.unmarshal (badan, & data)
    jika err! = nil {
        http.error (w, err.error (), http.statusbadrequest)
        Kembali
    }

    // data pemprosesan ...
    // Sebagai contoh: fmt.printf ("Nama: %s, Umur: %d \ n", data.name, data.age)
}

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

Dalam contoh ini, struktur myRequestData mentakrifkan struktur data yang kami harapkan untuk menerima dari badan permintaan JSON. json:"name" dan json:"age" Pastikan pemetaan medan JSON yang betul ke medan struktur Golang. Kod ini mengandungi pengendalian ralat yang diperlukan untuk memastikan keteguhan program. Ingatlah untuk memanggil r.Body.Close() selepas memproses badan permintaan, tutup badan permintaan.

Melalui langkah -langkah di atas, anda boleh menggunakan SWAG dengan berkesan untuk menghasilkan dokumen API dan betul memproses parameter permintaan JSON dalam kod Golang, dengan itu meningkatkan kecekapan pembangunan dan kualiti kod. Sila ubah struktur myRequestData dan pemprosesan logik mengikut keperluan sebenar anda.

Atas ialah kandungan terperinci Bagaimana cara menggunakan swag untuk mengendalikan parameter permintaan JSON di Golang?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!