Gin实践 连载四 搭建Blog API's(三)
编写Article的API's、Models项目地址:https://github.com/EDDYCJY/go... 定义接口本节编写文章的逻辑,我们定义一下接口吧!
编写路由逻辑在 package v1 import ( "github.com/gin-gonic/gin" ) //获取单个文章 func GetArticle(c *gin.Context) { } //获取多个文章 func GetArticles(c *gin.Context) { } //新增文章 func AddArticle(c *gin.Context) { } //修改文章 func EditArticle(c *gin.Context) { } //删除文章 func DeleteArticle(c *gin.Context) { } 我们打开 package routers import ( "github.com/gin-gonic/gin" "gin-blog/routers/api/v1" "gin-blog/pkg/setting" ) func InitRouter() *gin.Engine { ... apiv1 := r.Group("/api/v1") { ... //获取文章列表 apiv1.GET("/articles",v1.GetArticles) //获取指定文章 apiv1.GET("/articles/:id",v1.GetArticle) //新建文章 apiv1.POST("/articles",v1.AddArticle) //更新指定文章 apiv1.PUT("/articles/:id",v1.EditArticle) //删除指定文章 apiv1.DELETE("/articles/:id",v1.DeleteArticle) } return r } 当前目录结构: gin-blog/ ├── conf │ └── app.ini ├── main.go ├── middleware ├── models │ ├── models.go │ └── tag.go ├── pkg │ ├── e │ │ ├── code.go │ │ └── msg.go │ ├── setting │ │ └── setting.go │ └── util │ └── pagination.go ├── routers │ ├── api │ │ └── v1 │ │ ├── article.go │ │ └── tag.go │ └── router.go ├── runtime 在基础的路由规则配置结束后,我们开始编写我们的接口吧! 编写models逻辑创建 package models import ( "github.com/jinzhu/gorm" "time" ) type Article struct { Model TagID int `json:"tag_id" gorm:"index"` Tag Tag `json:"tag"` Title string `json:"title"` Desc string `json:"desc"` Content string `json:"content"` CreatedBy string `json:"created_by"` ModifiedBy string `json:"modified_by"` State int `json:"state"` } func (article *Article) BeforeCreate(scope *gorm.Scope) error { scope.SetColumn("CreatedOn",time.Now().Unix()) return nil } func (article *Article) BeforeUpdate(scope *gorm.Scope) error { scope.SetColumn("ModifiedOn",time.Now().Unix()) return nil } 我们创建了一个
接下来,请确保已对上一章节的内容通读且了解,由于逻辑偏差不会太远,我们本节直接编写这五个接口 打开 package models import ( "time" "github.com/jinzhu/gorm" ) type Article struct { Model TagID int `json:"tag_id" gorm:"index"` Tag Tag `json:"tag"` Title string `json:"title"` Desc string `json:"desc"` Content string `json:"content"` CreatedBy string `json:"created_by"` ModifiedBy string `json:"modified_by"` State int `json:"state"` } func ExistArticleByID(id int) bool { var article Article db.Select("id").Where("id = ?",id).First(&article) if article.ID > 0 { return true } return false } func GetArticleTotal(maps interface {}) (count int){ db.Model(&Article{}).Where(maps).Count(&count) return } func GetArticles(pageNum int,pageSize int,maps interface {}) (articles []Article) { db.Preload("Tag").Where(maps).Offset(pageNum).Limit(pageSize).Find(&articles) return } func GetArticle(id int) (article Article) { db.Where("id = ?",id).First(&article) db.Model(&article).Related(&article.Tag) return } func EditArticle(id int,data interface {}) bool { db.Model(&Article{}).Where("id = ?",id).Updates(data) return true } func AddArticle(data map[string]interface {}) bool { db.Create(&Article { TagID : data["tag_id"].(int),Title : data["title"].(string),Desc : data["desc"].(string),Content : data["content"].(string),CreatedBy : data["created_by"].(string),State : data["state"].(int),}) return true } func DeleteArticle(id int) bool { db.Where("id = ?",id).Delete(Article{}) return true } func (article *Article) BeforeCreate(scope *gorm.Scope) error { scope.SetColumn("CreatedOn",time.Now().Unix()) return nil } 在这里,我们拿出三点不同来讲 1、 我们的 func GetArticle(id int) (article Article) { db.Where("id = ?",id).First(&article) db.Model(&article).Related(&article.Tag) return } 能够达到关联,首先是
2、 func GetArticles(pageNum int,maps interface {}) (articles []Article) { db.Preload("Tag").Where(maps).Offset(pageNum).Limit(pageSize).Find(&articles) return }
那么有没有别的办法呢,大致是两种
综合之下,还是 3、
打开 package v1 import ( "net/http" "log" "github.com/gin-gonic/gin" "github.com/astaxie/beego/validation" "github.com/Unknwon/com" "gin-blog/models" "gin-blog/pkg/e" "gin-blog/pkg/setting" "gin-blog/pkg/util" ) //获取单个文章 func GetArticle(c *gin.Context) { id := com.StrTo(c.Param("id")).MustInt() valid := validation.Validation{} valid.Min(id,1,"id").Message("ID必须大于0") code := e.INVALID_PARAMS var data interface {} if ! valid.HasErrors() { if models.ExistArticleByID(id) { data = models.GetArticle(id) code = e.SUCCESS } else { code = e.ERROR_NOT_EXIST_ARTICLE } } else { for _,err := range valid.Errors { logging.Info(err.Key,err.Message) } } c.JSON(http.StatusOK,gin.H{ "code" : code,"msg" : e.GetMsg(code),"data" : data,}) } //获取多个文章 func GetArticles(c *gin.Context) { data := make(map[string]interface{}) maps := make(map[string]interface{}) valid := validation.Validation{} var state int = -1 if arg := c.Query("state"); arg != "" { state = com.StrTo(arg).MustInt() maps["state"] = state valid.Range(state,"state").Message("状态只允许0或1") } var tagId int = -1 if arg := c.Query("tag_id"); arg != "" { tagId = com.StrTo(arg).MustInt() maps["tag_id"] = tagId valid.Min(tagId,"tag_id").Message("标签ID必须大于0") } code := e.INVALID_PARAMS if ! valid.HasErrors() { code = e.SUCCESS data["lists"] = models.GetArticles(util.GetPage(c),setting.PageSize,maps) data["total"] = models.GetArticleTotal(maps) } else { for _,}) } //新增文章 func AddArticle(c *gin.Context) { tagId := com.StrTo(c.Query("tag_id")).MustInt() title := c.Query("title") desc := c.Query("desc") content := c.Query("content") createdBy := c.Query("created_by") state := com.StrTo(c.DefaultQuery("state","0")).MustInt() valid := validation.Validation{} valid.Min(tagId,"tag_id").Message("标签ID必须大于0") valid.Required(title,"title").Message("标题不能为空") valid.Required(desc,"desc").Message("简述不能为空") valid.Required(content,"content").Message("内容不能为空") valid.Required(createdBy,"created_by").Message("创建人不能为空") valid.Range(state,"state").Message("状态只允许0或1") code := e.INVALID_PARAMS if ! valid.HasErrors() { if models.ExistTagByID(tagId) { data := make(map[string]interface {}) data["tag_id"] = tagId data["title"] = title data["desc"] = desc data["content"] = content data["created_by"] = createdBy data["state"] = state models.AddArticle(data) code = e.SUCCESS } else { code = e.ERROR_NOT_EXIST_TAG } } else { for _,"data" : make(map[string]interface{}),}) } //修改文章 func EditArticle(c *gin.Context) { valid := validation.Validation{} id := com.StrTo(c.Param("id")).MustInt() tagId := com.StrTo(c.Query("tag_id")).MustInt() title := c.Query("title") desc := c.Query("desc") content := c.Query("content") modifiedBy := c.Query("modified_by") var state int = -1 if arg := c.Query("state"); arg != "" { state = com.StrTo(arg).MustInt() valid.Range(state,"state").Message("状态只允许0或1") } valid.Min(id,"id").Message("ID必须大于0") valid.MaxSize(title,100,"title").Message("标题最长为100字符") valid.MaxSize(desc,255,"desc").Message("简述最长为255字符") valid.MaxSize(content,65535,"content").Message("内容最长为65535字符") valid.Required(modifiedBy,"modified_by").Message("修改人不能为空") valid.MaxSize(modifiedBy,"modified_by").Message("修改人最长为100字符") code := e.INVALID_PARAMS if ! valid.HasErrors() { if models.ExistArticleByID(id) { if models.ExistTagByID(tagId) { data := make(map[string]interface {}) if tagId > 0 { data["tag_id"] = tagId } if title != "" { data["title"] = title } if desc != "" { data["desc"] = desc } if content != "" { data["content"] = content } data["modified_by"] = modifiedBy models.EditArticle(id,data) code = e.SUCCESS } else { code = e.ERROR_NOT_EXIST_TAG } } else { code = e.ERROR_NOT_EXIST_ARTICLE } } else { for _,"data" : make(map[string]string),}) } //删除文章 func DeleteArticle(c *gin.Context) { id := com.StrTo(c.Param("id")).MustInt() valid := validation.Validation{} valid.Min(id,"id").Message("ID必须大于0") code := e.INVALID_PARAMS if ! valid.HasErrors() { if models.ExistArticleByID(id) { models.DeleteArticle(id) code = e.SUCCESS } else { code = e.ERROR_NOT_EXIST_ARTICLE } } else { for _,}) } 当前目录结构: gin-blog/ ├── conf │ └── app.ini ├── main.go ├── middleware ├── models │ ├── article.go │ ├── models.go │ └── tag.go ├── pkg │ ├── e │ │ ├── code.go │ │ └── msg.go │ ├── setting │ │ └── setting.go │ └── util │ └── pagination.go ├── routers │ ├── api │ │ └── v1 │ │ ├── article.go │ │ └── tag.go │ └── router.go ├── runtime 验证功能我们重启服务,执行 $ go run main.go [GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production. - using env: export GIN_MODE=release - using code: gin.SetMode(gin.ReleaseMode) [GIN-debug] GET /api/v1/tags --> gin-blog/routers/api/v1.GetTags (3 handlers) [GIN-debug] POST /api/v1/tags --> gin-blog/routers/api/v1.AddTag (3 handlers) [GIN-debug] PUT /api/v1/tags/:id --> gin-blog/routers/api/v1.EditTag (3 handlers) [GIN-debug] DELETE /api/v1/tags/:id --> gin-blog/routers/api/v1.DeleteTag (3 handlers) [GIN-debug] GET /api/v1/articles --> gin-blog/routers/api/v1.GetArticles (3 handlers) [GIN-debug] GET /api/v1/articles/:id --> gin-blog/routers/api/v1.GetArticle (3 handlers) [GIN-debug] POST /api/v1/articles --> gin-blog/routers/api/v1.AddArticle (3 handlers) [GIN-debug] PUT /api/v1/articles/:id --> gin-blog/routers/api/v1.EditArticle (3 handlers) [GIN-debug] DELETE /api/v1/articles/:id --> gin-blog/routers/api/v1.DeleteArticle (3 handlers) 使用
至此,我们的API's编写就到这里,下一节我们将介绍另外的一些技巧! 参考本系列示例代码
本系列目录
(编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |