Bagaimana untuk melaksanakan API menggunakan bahasa Golang

Dengan pembangunan berterusan teknologi Internet dan aplikasi Internet mudah alih, API (Antara Muka Pengaturcaraan Aplikasi) telah menjadi cara teknikal yang sangat diperlukan untuk pembangun. Dalam artikel ini, kami akan memperkenalkan cara melaksanakan API menggunakan bahasa Golang.

Apa itu Golang?

Golang ialah bahasa pengaturcaraan yang dikeluarkan oleh Google pada tahun 2007. Tujuannya adalah "mudah, cepat dan selamat". Golang mempunyai ciri bahasa peringkat tinggi seperti pengurusan memori dan pengumpulan sampah, dan pada masa yang sama mempunyai prestasi hampir dengan bahasa C, jadi ia digunakan secara meluas dalam pelayan rangkaian, pengkomputeran awan dan bidang lain.

Langkah-langkah untuk melaksanakan API di Golang

1. Tentukan format data API

Sebelum mula membangunkan API, anda perlu menentukan data format yang dikembalikan oleh API. API boleh mengembalikan pelbagai format data, seperti JSON, XML, dsb. Antaranya, JSON ialah format data API yang paling popular pada masa ini kerana ia mudah dihuraikan dan dijana serta boleh diproses dengan mudah oleh bahasa pengaturcaraan yang berbeza.

2. Reka bentuk antara muka API

Apabila mereka bentuk antara muka API, anda perlu mempertimbangkan aspek berikut:

(1) Kaedah HTTP: API boleh menyokong GET , POST, PUT, DELETE dan kaedah HTTP lain, antaranya kaedah GET digunakan untuk mendapatkan sumber, kaedah POST digunakan untuk mencipta sumber, kaedah PUT digunakan untuk mengemas kini sumber, dan kaedah DELETE digunakan untuk memadam sumber. .

(2) Alamat API: Alamat API seharusnya dapat menentukan lokasi sumber dengan jelas. Contohnya, "/users" boleh mewakili sumber pengguna.

(3) Permintaan parameter: API boleh menerima pelbagai jenis parameter, seperti parameter pertanyaan, parameter borang, dll. Pembangun perlu mentakrifkan parameter ini dengan jelas.

(4) Pengepala permintaan: API boleh menerima maklumat pengepala, seperti maklumat pengesahan, jenis kandungan, dsb.

(5) Respons: API seharusnya dapat menentukan format dan kod status kandungan respons dengan jelas.

3. Menulis kod API

Tugas utama kod API adalah untuk memproses permintaan, menghuraikan parameter, mengesahkan maklumat identiti, membaca atau mengemas kini data dan menjana respons. Berikut ialah contoh API Golang yang mudah:

package main

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

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

func main() {
    http.HandleFunc("/users", usersHandler)
    err := http.ListenAndServe(":8080", nil)
    if err != nil {
        log.Fatal("ListenAndServe: ", err)
    }
}

func usersHandler(w http.ResponseWriter, r *http.Request) {
    users := []User{{"张三", 20}, {"李四", 22}, {"王五", 24}}
    json, err := json.Marshal(users)
    if err != nil {
        log.Fatal("json.Marshal: ", err)
    }
    w.Header().Set("Content-Type", "application/json;charset=UTF-8")
    w.Write(json)
}

Kod di atas mencipta perkhidmatan HTTP dan mentakrifkan laluan "/users". Permintaan GET akan mengembalikan senarai pengguna dalam format JSON. Kita boleh menggunakan arahan curl untuk mengujinya:

$ curl http://localhost:8080/users
[{"name":"张三","age":20},{"name":"李四","age":22},{"name":"王五","age":24}]

Contoh di atas hanyalah API mudah Dalam pembangunan sebenar, logik perniagaan yang lebih kompleks perlu diproses, seperti pengesahan data, pengurusan kebenaran, dsb .

4. Menguji API

Dalam proses membangunkan API, API perlu diuji untuk memastikan ia berfungsi dengan baik. Ujian boleh menggunakan ujian automatik, ujian manual, dll. Ujian automatik boleh meningkatkan kecekapan ujian dan liputan ujian.

Berikut ialah contoh ujian automatik Golang yang ringkas:

package main

import (
    "net/http"
    "net/http/httptest"
    "testing"
)

func TestUsersHandler(t *testing.T) {
    req, err := http.NewRequest("GET", "/users", nil)
    if err != nil {
        t.Fatal(err)
    }

    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(usersHandler)

    handler.ServeHTTP(rr, req)

    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }

    expected := `[{"name":"张三","age":20},{"name":"李四","age":22},{"name":"王五","age":24}]`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}

Kod di atas menggunakan pakej httptest terbina dalam Golang untuk mensimulasikan permintaan HTTP dan menguji responsnya.

Kesimpulan

Artikel ini memperkenalkan cara menggunakan bahasa Golang untuk melaksanakan API, termasuk menentukan format data API, mereka bentuk antara muka API, menulis kod API dan menguji API. Walaupun contoh di atas hanyalah API mudah, ia boleh memberikan rujukan untuk pemula untuk membantu mereka memahami cara Golang melaksanakan API. Pada masa hadapan, kami merancang untuk memperkenalkan lebih banyak kemahiran dan pengalaman praktikal dalam pembangunan API Golang, jadi nantikan.

Atas ialah kandungan terperinci Bagaimana untuk melaksanakan API menggunakan bahasa Golang. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!