使用 Go 和 Gin 开发 RESTful API
教程
Gin Web 框架包文档 ：包的说明
Gin Web 框架文档：使用文档
AsciiJSON：将json格式携带的数据转换为以纯Ascii进行编码
HTML渲染：将go程序中的变量，用到html文件中
JSONP：不知道什么意思？
基本使用
参考教程：使用 Go 和 Gin 开发 RESTful API
发送get请求，返回json数据
mkdir web-service-gin
cd web-service-gin
go mod init example/web-service-gin
main.go：
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
// album 表示有关专辑的数据.
type album struct {
ID string `json:"id"`
Title string `json:"title"`
Artist string `json:"artist"`
Price float64 `json:"price"`
}
// 专辑切片以填充专辑数据记录.
var albums = []album{
{ID: "1", Title: "Blue Train", Artist: "John Coltrane", Price: 56.99},
{ID: "2", Title: "Jeru", Artist: "Gerry Mulligan", Price: 17.99},
{ID: "3", Title: "Sarah Vaughan and Clifford Brown", Artist: "Sarah Vaughan", Price: 39.99},
}
func main() {
router := gin.Default()
router.GET("/albums", getAlbums)
router.Run("localhost:8080")
}
// getAlbums 以 JSON 格式响应所有专辑的列表.
func getAlbums(c *gin.Context) { // gin.Context是Gin最重要的部分。它携带请求详细信息、验证和序列化 JSON 等。
c.IndentedJSON(http.StatusOK, albums) // 也可以使用c.JSON，只不过c.IndentedJSON有缩进，更具可读性。
}
- album说明：album中的每个字段的注释中包含一个 json 标记，表示这个结构体可以被序列化为 JSON 格式的数据。在该标记中，json:"" 指定了序列化后 JSON 对象中对应的字段名。例如，ID 字段在序列化为 JSON 对象时对应的字段名为 "id"，Title 字段对应的字段名为 "title"。
- c.IndentedJSON(http.StatusOK, albums)：c.IndentedJSON()是将一个结构体序列化为json并返回给客户端。第一个参数是HTTP状态码，第二个参数是要序列化的数据。
获取依赖和运行：
go get . # 获取当前目录中代码的依赖项
go run . # 运行
用 curl向正在运行的 Web 服务发出请求。
curl http://localhost:8080/albums
发送post请求
修改main.go：
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
// album 表示有关专辑的数据.
type album struct {
ID string `json:"id"`
Title string `json:"title"`
Artist string `json:"artist"`
Price float64 `json:"price"`
}
// 专辑切片以填充专辑数据记录.
var albums = []album{
{ID: "1", Title: "Blue Train", Artist: "John Coltrane", Price: 56.99},
{ID: "2", Title: "Jeru", Artist: "Gerry Mulligan", Price: 17.99},
{ID: "3", Title: "Sarah Vaughan and Clifford Brown", Artist: "Sarah Vaughan", Price: 39.99},
}
func main() {
router := gin.Default()
router.GET("/albums", getAlbums)
router.POST("/albums", postAlbums)
router.Run("localhost:8080")
}
// getAlbums 以 JSON 格式响应所有专辑的列表.
func getAlbums(c *gin.Context) { // gin.Context是Gin最重要的部分。它携带请求详细信息、验证和序列化 JSON 等。
c.IndentedJSON(http.StatusOK, albums) // 也可以使用Context.JSON
}
// postAlbums 从请求体中收到的JSON中添加一个专辑。并将此专辑进行返回
func postAlbums(c *gin.Context) {
var newAlbum album
// 调用 BindJSON 将收到的 JSON 绑定到
// newAlbum.
if err := c.BindJSON(&newAlbum); err != nil { // 这里获取了err值，并判断了err值是否为nil
return
}
// 将新专辑添加到切片.
albums = append(albums, newAlbum)
c.IndentedJSON(http.StatusCreated, newAlbum)
}
curl添加专辑：
curl http://localhost:8080/albums \
--include \
--header "Content-Type: application/json" \
--request "POST" \
--data '{"id": "4","title": "The Modern Sound of Betty Carter","artist": "Betty Carter","price": 49.99}'
用 curl向正在运行的 Web 服务发出请求，查看此刻的专辑
curl http://localhost:8080/albums
说明：getAlbums返回的内容中只包含响应正文；postAlbums返回的内容包含了状态行、消息报头、空行和响应正文。这是因为在http协议中，GET请求的响应通常只包含请求的资源，而POST请求的响应通常包含操作的结果或者状态信息。因为GET请求是用于获取资源的，而POST请求通常用于修改或者更新资源。这和http.StatusOK和http.StatusCreated无关，只和请求类型有关，一个是get，一个是post。
获取url上的参数
修改main.go：
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
// album 表示有关专辑的数据.
type album struct {
ID string `json:"id"`
Title string `json:"title"`
Artist string `json:"artist"`
Price float64 `json:"price"`
}
// 专辑切片以填充专辑数据记录.
var albums = []album{
{ID: "1", Title: "Blue Train", Artist: "John Coltrane", Price: 56.99},
{ID: "2", Title: "Jeru", Artist: "Gerry Mulligan", Price: 17.99},
{ID: "3", Title: "Sarah Vaughan and Clifford Brown", Artist: "Sarah Vaughan", Price: 39.99},
}
func main() {
router := gin.Default()
router.GET("/albums", getAlbums)
router.GET("/albums/:id", getAlbumByID)
router.POST("/albums", postAlbums)
router.Run("localhost:8080")
}
// getAlbums 以 JSON 格式响应所有专辑的列表.
func getAlbums(c *gin.Context) { // gin.Context是Gin最重要的部分。它携带请求详细信息、验证和序列化 JSON 等。
c.IndentedJSON(http.StatusOK, albums) // 也可以使用Context.JSON
}
// postAlbums 从请求体中收到的JSON中添加一个专辑。并将此专辑进行返回
func postAlbums(c *gin.Context) {
var newAlbum album
// 调用 BindJSON 将收到的 JSON 绑定到
// newAlbum.
if err := c.BindJSON(&newAlbum); err != nil { // 这里获取了err值，并判断了err值是否为nil
return
}
// 将新专辑添加到切片.
albums = append(albums, newAlbum)
c.IndentedJSON(http.StatusCreated, newAlbum)
}
// getAlbumByID 查找 ID 值与客户端发送的 id
// 参数匹配的专辑，然后返回该专辑作为响应.
func getAlbumByID(c *gin.Context) {
id := c.Param("id")
// 循环浏览专辑列表，查找
// ID 值与参数匹配的专辑.
for _, a := range albums {
if a.ID == id {
c.IndentedJSON(http.StatusOK, a)
return
}
}
c.IndentedJSON(http.StatusNotFound, gin.H{"message": "album not found"})
}
运行：
go run .
发送请求：
curl http://localhost:8080/albums/2
