Gin(九):生成 restful 接口

https://juejin.im/post/5d3cf4a151882565f2663c66

不知不觉的已经更新到了第九篇,希望给读者有所帮助吧。

原文首发于 ISLAND

经过前面几章节的学习,基本对 Gin 中的一些概念和函数有所了解和掌握,也知道如何在代码中对其进行使用,那么接下来,我们将目光回到很久很久以前,具体多久呢?估摸着就是你在学习第二章 Gin 路由 的时候。

今天,不在模板上做文章了,而是要开启新的章节,我们叫它 restful

?restful 是什么

说到 restful 相信很多乃至大量的朋友们都不陌生,如果你已经知道那就直接看下一个章节,但还是有很多小伙伴是第一次接触,那么这里就简单介绍一下restful

简单的说 restful 就是一种 接口定义风格,比如说之前我们的接口对于更新用户可能这样定义, /update_user 对于获取当前用户可能是 get_user ,删除当前用户为 /delete_user ,而现在使用 restful 风格的接口,那么我们对于更新用户的接口定义为 /user,获取用户定义为 /user ,删除用户为 /user

???…………………………???

第一次接触的朋友肯定是满脸问号,所以我访问一下 /user 数据是更新了?删除了?还是获取一个用户?所以说一个完整的 restful 风格的接口并不是只是 url 的定义,还有请求方式。

还记得第二章中对于 gin 提供的 http 请求方式的说明吗?所以一个完整的 restful 请求需要加上请求方式。对于更新用户我们的接口应该是用 update 请求 `/user,对于获取用户应该用get请求方式/user,对于删除用户应该用delete请求/user 接口。

这里只对 restful 请求方式做最简单的介绍。

?第一个接口

我们现在来进行一个关于文章接口的展示,仍旧是连接上数据库,数据存在数据库中。

首先建立数据库,仍旧是在我们之前使用的数据库上建立新的表 article ,下面为建表语句,并且连接数据库。

  1. create table ` article`
  2. (
  3. id int auto_increment
  4. primary key,
  5. type varchar(20) null,
  6. content text not null
  7. );

首先我们要有一个模型来和表结构对应,也用于我们接收前端的数据绑定。

新建 model 文件夹,在 model 文件夹中建立 article.go

  1. type Article struct {
  2. Id int `json:"id"`
  3. Type string `json:"type"`
  4. Content string `json:"content"`
  5. }

通过标注 json 来进行对前端数据获取是的绑定。

接下来就可以完成第一个功能了,向数据库新增一个 article 。在 article.go 中完成向数据添加数据的代码,这里代码不做解释,和之前一致。

  1. func (article Article) Insert() int {
  2. result, e := initDB.Db.Exec("insert into ` article` (type, content) values (?, ?);", article.Type, article.Content)
  3. if e != nil {
  4. log.Panicln("文章添加失败", e.Error())
  5. }
  6. i, _ := result.LastInsertId()
  7. return int(i)
  8. }

完成 model 层,就可以完成 handler

handler 下新建 article/articleHandler.go

我们首要要获取前端穿过来的数据。通过 context.ShouldBindJSON 来对数据进行绑定。如果绑定成功,则调用我们上面写的增加方法进行添加。当完成后,通过 context.JSON 返回 json 数据。

  1. func Insert(context *gin.Context) {
  2. article := model.Article{}
  3. var id = -1
  4. if e := context.ShouldBindJSON(&article); e == nil {
  5. id = article.Insert()
  6. }
  7. context.JSON(http.StatusOK, gin.H{
  8. "id": id,
  9. })
  10. }

最后,我们完成对应的路由。

initRouter 中的 SetupRouter 中完善路由配置。

  1. articleRouter := router.Group("")
  2. {
  3. // 添加一篇文章
  4. articleRouter.POST("/article", article.Insert)
  5. }

⭕测试

当这一切完成后就是运行测试了。

当然我们最好编写单元测试。

test 文件夹中,新建 article_test.go 测试文件。

  1. package test
  2. import (
  3. "GinHello/initRouter"
  4. "GinHello/model"
  5. "bytes"
  6. "encoding/json"
  7. "github.com/gin-gonic/gin"
  8. "gopkg.in/go-playground/assert.v1"
  9. "net/http"
  10. "net/http/httptest"
  11. "testing"
  12. )
  13. var router *gin.Engine
  14. func init() {
  15. router = initRouter.SetupRouter()
  16. }
  17. func TestInsertArticle(t *testing.T) {
  18. article := model.Article{
  19. Type: "go",
  20. Content: "hello gin",
  21. }
  22. marshal, _ := json.Marshal(article)
  23. w := httptest.NewRecorder()
  24. req := httptest.NewRequest(http.MethodPost, "/article", bytes.NewBufferString(string(marshal)))
  25. req.Header.Add("content-typ", "application/json")
  26. router.ServeHTTP(w, req)
  27. assert.Equal(t, w.Code, http.StatusOK)
  28. assert.NotEqual(t, "{id:-1}", w.Body.String())
  29. }

在测试用例里创建一个 article 对象,并且赋值,通过 json 方法建对象转换为 json,最后发起请求。

运行测试用例,如果我们的代码写的 没有问题的话,测试通过,并且数据库中会对应添加该数据。

当然你不想写单元测试也是可以的,可以通过 Postman 等来进行测试,这里给大家简单的介绍一下 GoLand Http 测试工具。

我们新建立一个 http_test 文件夹,在文件夹下面新建一个 .http 文件,命名为 article.http

新建.http文件

对文件进行编写,编写如下,指定我们的请求地址,指定要求的数据。在POST 左侧就会出现一个 运行按钮,点击运行按钮,控制台会出现返回结果。运行该文件时,要将我们的项目启动起来。

  1. POST http://localhost:8080/article
  2. Content-Type: application/json
  3. {
  4. "type": "go",
  5. "content": "Hello Go"
  6. }

其他的 .http 文件的语法规则 请看官方文档

这样就完成了第一个 restful 接口,同样可以完成其他的接口。其他的接口示例请看 Github 上代码。

✍总结

本章节主要讲述了如何构建一套 restful 接口,restful 接口对于现在的开发是越来越重要了,大量的接口都是 restful 风格。Github 上代码完成了查询,添加,删除等接口,篇幅有限,不展开多讲了。

?‍?本章节示例代码

https://github.com/youngxhui/GinHello/tree/gin_restful

推荐阅读

Gin(一):Hello
Gin(二):路由Router
Gin(三):模板tmpl
Gin(四):表单提交校验和模型绑定
Gin(五):连接MySQL
Gin(六):文件的上传
Gin(七):中间件的使用和定义
Gin(八):Cookie的使用
Gin(九):生成restful接口

个人公众号

个人公众号刚刚建立,希望大家给个关注,会更新 java,go, kotlin 等相关文章

ft_authoradmin  ft_create_time2019-07-31 14:47
 ft_update_time2019-07-31 14:48