[Go语言] 基于Go语言构建RESTful API服务

• 什么是 RESTful API
  
• 一个简单的 RESTful API
  
• RESTful JSON API
  
• Gin 框架
  
  
  
  • 引入 Gin 框架
    
  • 使用 Gin 框架
    
  • 新增一个用户
    
  • 获取特定的用户
    
  
  
• 总结
  

   

• GET 方法可请求一个指定资源的表示形式，使用 GET 的请求应该只被用于获取数据。   
  
• HEAD 方法用于请求一个与 GET 请求的响应相同的响应，但没有响应体。   
  
• POST 方法用于将实体提交到指定的资源，通常导致服务器上的状态变化或副作用。   
  
• PUT 方法用于请求有效载荷替换目标资源的所有当前表示。   
  
• DELETE 方法用于删除指定的资源。   
  
• CONNECT 方法用于建立一个到由目标资源标识的服务器的隧道。   
  
• OPTIONS 方法用于描述目标资源的通信选项。   
  
• TRACE 方法用于沿着到目标资源的路径执行一个消息环回测试。   
  
• PATCH 方法用于对资源应用部分修改。
  

   

• GET，表示读取服务器上的资源；   
  
• POST，表示在服务器上创建资源；   
  
• PUT，表示更新或者替换服务器上的资源；   
  
• DELETE，表示删除服务器上的资源；   
  
• PATCH，表示更新 / 修改资源的一部分。
  

HTTP GET http://localhost:1000/users
HTTP GET http://localhost:1000/user/123

   

• 第一个表示获取所有用户的信息   
  
• 第二个表示获取 ID 为 123 用户的信息
  

HTTP POST http://localhost:1000/user

HTTP PUT http://localhost:1000/user/123

HTTP DELETE http://localhost:1000/user/123

func main() {
   http.HandleFunc("/users",handleUsers)
   http.ListenAndServe(":1000", nil)
}
func handleUsers(w http.ResponseWriter, r *http.Request){
   fmt.Fprintln(w,"ID:1,Name:张三")
   fmt.Fprintln(w,"ID:2,Name:李四")
   fmt.Fprintln(w,"ID:3,Name:王五")
}

ID:1,Name:张三
ID:2,Name:李四
ID:3,Name:王五

func handleUsers(w http.ResponseWriter, r *http.Request){
   switch r.Method {
   case "GET":
    w.WriteHeader(http.StatusOK)
    fmt.Fprintln(w,"ID:1,Name:张三")
    fmt.Fprintln(w,"ID:2,Name:李四")
    fmt.Fprintln(w,"ID:3,Name:王五")
   default:
    w.WriteHeader(http.StatusNotFound)
    fmt.Fprintln(w,"not found")
   }
}

//数据源，类似MySQL中的数据
var users = []User{
   {ID: 1,Name: "张三"},
   {ID: 2,Name: "李四"},
   {ID: 3,Name: "王五"},
}
func handleUsers(w http.ResponseWriter, r *http.Request){
   switch r.Method {
   case "GET":
    users,err:=json.Marshal(users)
    if err!=nil {
     w.WriteHeader(http.StatusInternalServerError)
     fmt.Fprint(w,"{"message": ""+err.Error()+""}")
    }else {
     w.WriteHeader(http.StatusOK)
     w.Write(users)
    }
   default:
    w.WriteHeader(http.StatusNotFound)
    fmt.Fprint(w,"{"message": "not found"}")
   }
}
//用户
type User struct {
   ID int
   Name string
}

[{"ID":1,"Name":"张三"},{"ID":2,"Name":"李四"},{"ID":3,"Name":"王五"}]

   

• 不能单独地对请求方法（POST、GET 等）注册特定的处理函数   
  
• 不支持 Path 变量参数   
  
• 不能自动对 Path 进行校准   
  
• 性能一般   
  
• 基于以上这些不足，出现了很多 Golang Web 框架，如 Mux，Gin、Fiber 等，今天我要为你介绍的就是这款使用最多的 Gin 框架。
  

go get -u github.com/gin-gonic/gin

import "github.com/gin-gonic/gin"

func main() {
   r:=gin.Default()
   r.GET("/users", listUser)
   r.Run(":1000")
}
func listUser(c *gin.Context)  {
   c.JSON(200,users)
}

func main() {
   //省略没有改动的代码
   r.POST("/users", createUser)
}
func createUser(c *gin.Context) {
   name := c.DefaultPostForm("name", "")
   if name != "" {
    u := User{ID: len(users) + 1, Name: name}
    users = append(users, u)
    c.JSON(http.StatusCreated,u)
   } else {
    c.JSON(http.StatusOK, gin.H{
     "message": "请输入用户名称",
    })
   }
}

➜ curl -X POST -d 'name=Ele' http://localhost:1000/users
{"ID":4,"Name":"Ele"}

func main() {
   //省略没有改动的代码
   r.GET("/users/:id", getUser)
}
func getUser(c *gin.Context) {
   id := c.Param("id")
   var user User
   found := false
   //类似于数据库的SQL查询
   for _, u := range users {
    if strings.EqualFold(id, strconv.Itoa(u.ID)) {
     user = u
     found = true
     break
    }
   }
   if found {
    c.JSON(200, user)
   } else {
    c.JSON(404, gin.H{
     "message": "用户不存在",
    })
   }
}

{"ID":4,"Name":"Ele"}

curl http://localhost:1000/users/99
{"message":"用户不存在"}