beego构建restful风格API

最新推荐文章于 2025-05-19 11:29:50 发布

wilson_go

最新推荐文章于 2025-05-19 11:29:50 发布

阅读量1.1k

点赞数

CC 4.0 BY-SA版权

分类专栏：实用工具 golang

本文链接：https://blog.youkuaiyun.com/qq_30505673/article/details/88747332

golang 同时被 2 个专栏收录

132 篇文章

订阅专栏

实用工具

121 篇文章

订阅专栏

博客介绍了新建 API 应用的相关操作。路由解析支持 namespace+Include 写法，且只支持二级解析。在 controller 中，需开启应用内文档开关，设置 EnableDocs = true，使用 bee run -gendoc=true -downdoc=true 让应用运行，同时要编辑好 controller 特别是 router。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.bee api beeapi 新建一个 API 应用做起来
2.

bee generate appcode -driver=postgres -conn="postgres://username:password@127.0.0.1:5435/database?sslmode=disable"

bee run -gendoc=true -downdoc=true

路由解析

支持如下的写法的解析，其他写法函数不会自动解析，即 namespace+Include 的写法，而且只支持二级解析，一级版本号，二级分别表示应用模块

func init() {
    ns :=
        beego.NewNamespace("/v1",
            beego.NSNamespace("/customer",
                beego.NSInclude(
                    &controllers.CustomerController{},
                    &controllers.CustomerCookieCheckerController{},
                ),
            ),
            beego.NSNamespace("/catalog",
                beego.NSInclude(
                    &controllers.CatalogController{},
                ),
            ),
            beego.NSNamespace("/newsletter",
                beego.NSInclude(
                    &controllers.NewsLetterController{},
                ),
            ),
            beego.NSNamespace("/cms",
                beego.NSInclude(
                    &controllers.CMSController{},
                ),
            ),
            beego.NSNamespace("/suggest",
                beego.NSInclude(
                    &controllers.SearchController{},
                ),
            ),
        )
    beego.AddNamespace(ns)
}

在controller中

package controllers

import "github.com/astaxie/beego"

// CMS API
type CMSController struct {
    beego.Controller
}

func (c *CMSController) URLMapping() {
    c.Mapping("StaticBlock", c.StaticBlock)
    c.Mapping("Product", c.Product)
}

// @Title getStaticBlock
// @Description get all the staticblock by key
// @Param   key     path    string  true        "The email for login"
// @Success 200 {object} models.ZDTCustomer.Customer
// @Failure 400 Invalid email supplied
// @Failure 404 User not found
// @router /staticblock/:key [get]
func (c *CMSController) StaticBlock() {

}

// @Title Get Product list
// @Description Get Product list by some info
// @Success 200 {object} models.ZDTProduct.ProductList
// @Param   category_id     query   int false       "category id"
// @Param   brand_id    query   int false       "brand id"
// @Param   query   query   string  false       "query of search"
// @Param   segment query   string  false       "segment"
// @Param   sort    query   string  false       "sort option"
// @Param   dir     query   string  false       "direction asc or desc"
// @Param   offset  query   int     false       "offset"
// @Param   limit   query   int     false       "count limit"
// @Param   price           query   float       false       "price"
// @Param   special_price   query   bool        false       "whether this is special price"
// @Param   size            query   string      false       "size filter"
// @Param   color           query   string      false       "color filter"
// @Param   format          query   bool        false       "choose return format"
// @Failure 400 no enough input
// @Failure 500 get products common error
// @router /products [get]
func (c *CMSController) Product() {

}

第一开启应用内文档开关，在配置文件中设置：EnableDocs = true,
然后使用 bee run -gendoc=true -downdoc=true,让我们的 API 应用跑起来，-gendoc=true 表示每次自动化的 build 文档，-downdoc=true 就会自动的下载 swagger 文档查看器

让项目运行 bee run -gendoc=true -downdoc=true

在models目录下的文件需要增加

 _ "github.com/lib/pq"
orm.RegisterDriver("postgres", orm.DRPostgres) // 注册驱动
	orm.RegisterDataBase("default", "postgres", "user=username password=password dbname=dbname host=127.0.0.1 port=5432 sslmode=disable")

编辑好controller特别是router！！！