Documentation
¶
Index ¶
- Constants
- type AddressController
- type BaseController
- type CartController
- type CommentController
- type ErrorController
- type LicenseController
- type OrderController
- func (c *OrderController) AddOrder()
- func (c *OrderController) Cancel()
- func (c *OrderController) CantRefund()
- func (c *OrderController) Complaint()
- func (c *OrderController) DelOrder()
- func (c *OrderController) GetOrderListToSeller()
- func (c *OrderController) OrderInIds()
- func (c *OrderController) OrderList()
- func (c *OrderController) OrderPay()
- func (c *OrderController) ReceivedOrder()
- func (c *OrderController) Refund()
- func (c *OrderController) SendOutOrder()
- type ProductController
- func (c *ProductController) GetAll()
- func (c *ProductController) GetCheckoutPkgInfo()
- func (c *ProductController) GetCommentInfoByProductId()
- func (c *ProductController) GetHome()
- func (c *ProductController) GetProductByPage()
- func (c *ProductController) GetProductCountInfo()
- func (c *ProductController) GetProductTypeList()
- func (c *ProductController) GetProductWithPkg()
- func (c *ProductController) GetProductsRandByTypeAndNum()
- func (c *ProductController) GetSellerByProductId()
- type ProductMangerController
- type UserControllers
- func (c *UserControllers) ChangePsw()
- func (c *UserControllers) GetInfoById()
- func (c *UserControllers) GetLicenseByUserId()
- func (c *UserControllers) GetUserById()
- func (c *UserControllers) Info()
- func (c *UserControllers) Login()
- func (c *UserControllers) Logout()
- func (c *UserControllers) OptionsUploadImage()
- func (c *UserControllers) Register()
- func (c *UserControllers) UpdateInfo()
- func (c *UserControllers) UploadImage()
- type VailUserController
Constants ¶
const SESSION_USER_KEY = "userId"
Session 中保存登录信息的 Key 值
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddressController ¶
type AddressController struct {
VailUserController
}
用户地址相关
func (*AddressController) DeleteAddress ¶
func (c *AddressController) DeleteAddress()
@Title 根据地址的 id 删除对应的地址 @Description 根据地址的 id 删除对应的地址 @Param id formData string true "地址的id" @Success 200 @Failure 400 @router /delete [post]
func (*AddressController) GetAddresses ¶
func (c *AddressController) GetAddresses()
@Title 根据 userId 获取收货地址 @Description 根据 userId 获取收货地址 @Success 200 {object} []models.Address @Failure 400 @router /all [get]
func (*AddressController) NewAddress ¶
func (c *AddressController) NewAddress()
@Title 添加新的地址 @Description 添加新的地址 @Param addressForm body forms.Address true "地址表单" @Success 200 @Failure 400 @router /new [post]
func (*AddressController) UpdateAddress ¶
func (c *AddressController) UpdateAddress()
@Title 更新指定 id 的地址 @Description 添加新的地址 @Param addressForm body forms.Address true "地址表单" @Success 200 @Failure 400 @router /update [post]
type BaseController ¶
type BaseController struct {
beego.Controller
}
定义 Controller 基类
func (*BaseController) CheckAndGetUser ¶
func (c *BaseController) CheckAndGetUser() (*models.User, error)
检查并获取对应的 User 信息
func (*BaseController) ResponseErrJson ¶
func (c *BaseController) ResponseErrJson(err error)
用于返回 err 减少代码量
func (*BaseController) ResponseJson ¶
func (c *BaseController) ResponseJson(result resultModels.Result)
用于返回 Json 格式的数据 这个项目里会用前后端分离的模式开发，返回的都是 Json 数据
func (*BaseController) ResponseSuccessJson ¶
func (c *BaseController) ResponseSuccessJson(data interface{})
返回成功的 Json 数据
type CartController ¶
type CartController struct {
VailUserController
}
用户购物车相关
func (*CartController) AddCart ¶
func (c *CartController) AddCart()
@Title 添加购物车 @Description 添加购物车 @Param cartForm body forms.CartForm true "购物车信息" @Success 200 @Failure 400 @router /addCart [post]
func (*CartController) CartDel ¶
func (c *CartController) CartDel()
@Title 删除当前用户指定 product_package_id 的购物车记录 @Description 删除当前用户指定 product_package_id 的购物车记录 @Param delCartForm body forms.DelCartForm true "购物车信息" @Success 200 @Failure 400 @router /cartDel [post]
func (*CartController) CartEdit ¶
func (c *CartController) CartEdit()
@Title 编辑购物车 @Description 编辑购物车 @Param cartForm body forms.CartForm true "购物车信息" @Success 200 @Failure 400 @router /cartEdit [post]
func (*CartController) CartList ¶
func (c *CartController) CartList()
@Title 购物车列表 @Description 获取购物车列表 @Success 200 {object} []models.Cart @Failure 400 @router /cartList [get]
func (*CartController) DelCartChecked ¶
func (c *CartController) DelCartChecked()
@Title 删除选中 @Description 删除选中 @Success 200 @Failure 400 @router /delCartChecked [post]
func (*CartController) EditCheckAll ¶
func (c *CartController) EditCheckAll()
@Title 全选/全不选 @Description 全选/全不选 @Param cartForm body forms.CheckAllForm true "购物车信息" @Success 200 @Failure 400 @router /editCheckAll [post]
type CommentController ¶
type CommentController struct {
VailUserController
}
产品详情获取评论列表是写在 /controller/product.go 里面 评论相关 主要是提交评论和回复，需要验证身份
func (*CommentController) SaveCommentsInfo ¶
func (c *CommentController) SaveCommentsInfo()
@Title 保存评论信息 @Description 保存评论信息 @Param form body models.CommentsInfo true "评论信息" @Success 200 @Failure 400 @router /saveCommentsInfo [post]
func (*CommentController) SaveCommentsReply ¶
func (c *CommentController) SaveCommentsReply()
@Title 保存回复信息 @Description 保存回复信息 @Param form body models.CommentsReply true "回复信息" @Success 200 @Failure 400 @router /saveCommentsReply [post]
type ErrorController ¶
type ErrorController struct {
beego.Controller
}
func (*ErrorController) Error404 ¶
func (c *ErrorController) Error404()
func (*ErrorController) Error501 ¶
func (c *ErrorController) Error501()
type LicenseController ¶
type LicenseController struct {
BaseController
}
营业执照相关 放在 /user/license 路由下吧
func (*LicenseController) SaveLicense ¶
func (c *LicenseController) SaveLicense()
@Title 保存产品 @Description 保存产品 @Param form body models.License true "产品model" @Success 200 @Failure 400 @router /save [post]
type OrderController ¶
type OrderController struct {
VailUserController
}
用户订单相关
func (*OrderController) AddOrder ¶
func (c *OrderController) AddOrder()
@Title 新增订单 @Description 新增订单 @Param orderForm body forms.NewOrderForm true "新增订单信息" @Success 200 @Failure 400 @router /addOrder [post]
func (*OrderController) Cancel ¶
func (c *OrderController) Cancel()
@Title 根据订单 ID 取消订单 @Description 根据订单 ID 取消订单 @Param form body forms.RefundForm true "订单ID" @Success 200 @Failure 400 @router /cancel [Post]
func (*OrderController) CantRefund ¶
func (c *OrderController) CantRefund()
@Title 卖家根据订单 ID 拒绝退款 @Description 卖家根据订单 ID 拒绝退款 @Param form body forms.RefundForm true "订单ID 和原因" @Success 200 @Failure 400 @router /cantRefund [Post]
func (*OrderController) Complaint ¶
func (c *OrderController) Complaint()
@Title 买家根据订单 ID 发起投诉 @Description 买家根据订单 ID 发起投诉 @Param form body forms.ComplaintForm true "订单ID" @Success 200 @Failure 400 @router /complaint [Post]
func (*OrderController) DelOrder ¶
func (c *OrderController) DelOrder()
@Title 根据订单 ID 删除订单 @Description 根据订单 ID 取消订单 @Param form body forms.IdForm true "订单ID" @Success 200 @Failure 400 @router /delOrder [Post]
func (*OrderController) GetOrderListToSeller ¶
func (c *OrderController) GetOrderListToSeller()
@Title 商家获取订单列表 @Description 商家获取订单列表 @Param form body forms.SellerGetOrderListForm true "订单ID列表" @Success 200 @Failure 400 @router /orderListToSeller [get]
func (*OrderController) OrderInIds ¶
func (c *OrderController) OrderInIds()
@Title 根据订单 Id 列表来获取订单列表 @Description 根据订单 Id 列表来获取订单列表 @Param orderId query string true "订单列表的Json字符串" @Success 200 @Failure 400 @router /orderInIds [get]
func (*OrderController) OrderList ¶
func (c *OrderController) OrderList()
@Title 根据页面信息来获取订单列表 @Description 根据页面信息来获取订单列表 @Param pageForm body forms.PageForm true "页码信息" @Success 200 @Failure 400 @router /orderList [get]
func (*OrderController) OrderPay ¶
func (c *OrderController) OrderPay()
@Title 根据订单 ID 列表来进行支付 @Description 根据订单 ID 列表来进行支付 @Param orderIds body []uint64 true "订单ID列表" @Success 200 @Failure 400 @router /orderPay [Post]
func (*OrderController) ReceivedOrder ¶
func (c *OrderController) ReceivedOrder()
@Title 根据订单 ID 确认收货 @Description 根据订单 ID 确认收货 @Param id body forms.IdForm true "订单ID" @Success 200 @Failure 400 @router /receivedOrder [Post]
func (*OrderController) Refund ¶
func (c *OrderController) Refund()
@Title 买家根据订单 ID 申请退款 @Description 买家根据订单 ID 申请退款 @Param form body forms.RefundForm true "订单ID" @Success 200 @Failure 400 @router /refund [Post]
func (*OrderController) SendOutOrder ¶
func (c *OrderController) SendOutOrder()
@Title 发货 @Description 发货 @Param form body forms.OrderSendOutForm true "发货参数" @Success 200 @Failure 400 @router /sendOutOrder [post]
type ProductController ¶
type ProductController struct {
BaseController
}
产品相关
func (*ProductController) GetAll ¶
func (c *ProductController) GetAll()
@Title Get All Products @Description 获取全部产品信息 @Success 200 @Failure 400 @router /all [get]
func (*ProductController) GetCheckoutPkgInfo ¶
func (c *ProductController) GetCheckoutPkgInfo()
@Title 获取结算所需的套餐信息 （给“立即支持”这个功能用） @Description 获取结算所需的套餐信息 （给“立即支持”这个功能用） @Param product_package_id query int true "套餐ID" @Success 200 {object} resultModels.CheckoutPkgInfo @Failure 400 @router /checkoutPkgInfo [get]
func (*ProductController) GetCommentInfoByProductId ¶
func (c *ProductController) GetCommentInfoByProductId()
@Title 根据商品 ID 获取商家信息 @Description 根据商品 ID 获取商家信息 @Param product_id query int true "套餐ID" @Param page query int true "页码" @Param page_size query int true "每页数量" @Success 200 @Failure 400 @router /getCommentInfoByProductId [get]
func (*ProductController) GetHome ¶
func (c *ProductController) GetHome()
@Title Get Home Page Info @Description 获取首页信息 @Success 200 @Failure 400 @router /home [get]
func (*ProductController) GetProductByPage ¶
func (c *ProductController) GetProductByPage()
@Title 据页码和其他条件获取产品信息 @Description 据页码和其他条件获取产品信息 @Param page query int true "页码" @Param page_size query int true "每页数量" @Param name query string false "产品名称" @Param type query int false "产品类型" @Param funding_status query int false "众筹状态" @Param sort query int false "排序方式" @Param price_gt query float64 false "价格大于" @Param price_lt query float64 false "价格小于" @Success 200 @Failure 400 @router /productList [get]
func (*ProductController) GetProductCountInfo ¶
func (c *ProductController) GetProductCountInfo()
@Title 获取统计信息 @Description 获取统计信息 @Success 200 @Failure 400 @router /getProductCountInfo [get]
func (*ProductController) GetProductTypeList ¶
func (c *ProductController) GetProductTypeList()
@Title 获取产品类型列表 @Description 获取产品类型列表 @Success 200 {object} []models.ProductType @Failure 400 @router /typeList [get]
func (*ProductController) GetProductWithPkg ¶
func (c *ProductController) GetProductWithPkg()
@Title Get Product With Detail @Description 根据 id 获取带有套餐信息的指定产品信息 @Param id query int true "商品ID" @Success 200 {object} models.Product @Failure 400 @router /detail [get]
func (*ProductController) GetProductsRandByTypeAndNum ¶
func (c *ProductController) GetProductsRandByTypeAndNum()
@Title 根据产品类型 和数量 获取随机数量的指定类型产品 @Description 根据产品类型 和数量 获取随机数量的指定类型产品 @Param product_type query int true "产品类型" @Param num query int true "查询数量" @Success 200 @Failure 400 @router /getProductsRand [get]
func (*ProductController) GetSellerByProductId ¶
func (c *ProductController) GetSellerByProductId()
@Title 根据商品 ID 获取商家信息 @Description 根据商品 ID 获取商家信息 @Param product_id query int true "套餐ID" @Success 200 @Failure 400 @router /getSellerByProductId [get]
type ProductMangerController ¶
type ProductMangerController struct {
VailUserController
}
产品管理相关（商家 审核员） 为了方便，这个 Controller 的 URL 地址缩写为 /pm
func (*ProductMangerController) GetAllProductBySellerId ¶
func (c *ProductMangerController) GetAllProductBySellerId()
@Title 根据卖家UserID 获取产品信息 (从Token里取UserID) @Description 根据卖家UserID 获取产品信息 (从Token里取UserID) @Success 200 @Failure 400 @router /allProductBySellerId [get]
func (*ProductMangerController) GetPkgListByProductId ¶
func (c *ProductMangerController) GetPkgListByProductId()
@Title 根据产品 Id 获取产品信息 @Description 根据卖家UserID 根据产品 Id 获取产品信息 @Param product_id query int true "套餐ID" @Success 200 @Failure 400 @router /pkgListByProductId [get]
func (*ProductMangerController) GetProductById ¶
func (c *ProductMangerController) GetProductById()
根据产品 Id 获取产品信息 @router /productById [get]
func (*ProductMangerController) SaveProduct ¶
func (c *ProductMangerController) SaveProduct()
@Title 保存产品 @Description 保存产品 @Param form body models.Product true "产品model" @Success 200 @Failure 400 @router /save [post]
func (*ProductMangerController) SaveProductPackage ¶
func (c *ProductMangerController) SaveProductPackage()
@Title 保存产品 @Description 保存产品 不知道怎么写文件参数，所以这个API 没法用 swagger 测试 @Success 200 @Failure 400 @router /saveProductPackage [post]
type UserControllers ¶
type UserControllers struct {
//嵌入 BaseController
BaseController
}
用户相关
func (*UserControllers) ChangePsw ¶
func (c *UserControllers) ChangePsw()
@Title 修改密码 @Description 修改密码 @Param form body forms.PswForm true "修改密码表单" @Accept form @Success 200 @Failure 400 @router /changePsw [post]
func (*UserControllers) GetInfoById ¶
func (c *UserControllers) GetInfoById()
@Title 根据 UserId 来获取对应 User 的信息 @Description 根据 UserId 来获取对应 User 的信息 @Param id query int true "用户ID" @Success 200 {object} models.User @Failure 400 @router /getInfoById [get]
func (*UserControllers) GetLicenseByUserId ¶
func (c *UserControllers) GetLicenseByUserId()
@Title 根据 user_id 来获取对应 License 的信息 @Description 根据 user_id 来获取对应 License 的信息 @Param user_id query int true "用户ID" @Success 200 {object} models.User @Failure 400 @router /getLicenseByUserId [get]
func (*UserControllers) GetUserById ¶
func (c *UserControllers) GetUserById()
@Title 根据 id 获取 User @Description 根据 Id（数据库表 Id ，不是账号）来获取对应用户信息 @Param id query int true "数据库 User 表ID" @Success 200 {object} models.User @Failure 400 @router /id [get]
func (*UserControllers) Info ¶
func (c *UserControllers) Info()
@Title 根据当前的 Session 查询对应的用户信息 @Description 用户登录之后查询当前登录的用户信息，每次查询会刷新 Session 有效期 @Success 200 {object} models.User @Failure 400 @router /info [get]
func (*UserControllers) Login ¶
func (c *UserControllers) Login()
@Title 登录 @Description 用账号密码登录 @Param userForm body forms.LoginForm true "登录账号密码" @Success 200 {object} models.User @Failure 400 @router /login [post]
func (*UserControllers) Logout ¶
func (c *UserControllers) Logout()
@Title 注销 @Description 注销 @Success 200 @Failure 400 @router /logout [post]
func (*UserControllers) OptionsUploadImage ¶
func (c *UserControllers) OptionsUploadImage()
仅仅是为了配合 element-ui 的上传空间写的 options 请求 api,返回成功即可 @router /uploadImage [options]
func (*UserControllers) Register ¶
func (c *UserControllers) Register()
@Title 注册 @Description 注册 @Param registerForm body forms.RegisterForm true "注册信息" @Description 注册 @Success 200 @Failure 400 @router /register [post]
func (*UserControllers) UpdateInfo ¶
func (c *UserControllers) UpdateInfo()
@Title 更新个人资料 @Description 更新个人资料 @Param form body models.User true "个人资料" @Accept form @Success 200 @Failure 400 @router /updateInfo [post]
func (*UserControllers) UploadImage ¶
func (c *UserControllers) UploadImage()
@Title 上传图片 @Description 上传图片 @Param file formData multipart.File true "图片文件" @Accept form @Success 200 @Failure 400 @router /uploadImage [post]
type VailUserController ¶
type VailUserController struct {
BaseController
User *models.User
}
所有请求都需要身份验证的 Controller
func (*VailUserController) VerifyAuditor ¶
func (c *VailUserController) VerifyAuditor() error
校验是否是审核员
func (*VailUserController) VerifySuperAdmin ¶
func (c *VailUserController) VerifySuperAdmin() error
校验是否是审核员
Source Files