GoFly 框架接口命名规则与实现方法
本文介绍 GoFly 快速开发框架新增接口及接口命名规则,通过示例说明在现有文件中添加接口和新建文件添加接口的开发方式。
接口命名规则
1. GET 请求命名
当接口以 Get 开头命名,比如 GetList、GetData、Get_list、Get 时,路由会将其注册为 get 请求。
2. DELETE 请求命名
当接口以 Del 开头命名,比如 DelArticle、DelData、Del 时,路由会将其注册为 delete 请求。
3. PUT 请求命名
当接口以 Put 开头命名,比如 PutArticle、PutData、Put 时,路由会将其注册为 put 请求。
4. GetPost 请求命名
当接口以 GetPost 开头命名,比如 GetPostArticle、GetPostData、GetPost 时,路由会将其注册为两个请求方式路径(GET 和 POST)。这种命名方式常用于微信公众号接收服务接口,验证有效时为 GET 请求,推送数据时为 POST 请求。
5. 默认是 Post 请求
除去以上 Get、Del、Put、GetPost 开头命名方式以外,系统将默认注册成 Post 请求方式。例如:Save、Status、DoMore、OnLink、Update 等都是 Post 请求。
6. 特别说明
由于 Go 语言规则,为了让其他 package 调用方法,首字母必须大写。然而接口为了满足驼峰命名规则,添加到路由上的地址时将命名的方法首字母改为小写。例如 GetList 变成 getList、DelArticle 变成 delArticle、PutArticle 变成 putArticle、GetPostArticle 变成 getPostArticle、Save 变成 save 等。
已有文件添加接口
在 app\business\article\cate.go 下存在 cate.go 文件,在原有文件里添加 Save 来保存添加文章分类数据,代码如下:
package article
import (
"gofly/utils/gf"
)
type Cate struct{}
// 文章分类
func init() {
fpath := Cate{}
gf.Register(&fpath, fpath)
}
// 保存数据
func (api *Cate) Save(c *gf.GinCtx) {
param, _ := gf.RequestParam(c)
data, err := gf.Model("gf_article_cate").Save(param)
if err != nil {
gf.Failed().SetMsg("保存失败").SetData(err).Resp(c)
} else {
gf.Success().SetMsg("保存成功").SetData(data).Resp(c)
}
}
这样就成功添加了 save 接口,路由自动加载,无需手动配置路由,避免手动添加产生路由冲突。



