v1

Documentation

Index

• Constants
• func AddArticle(c *gin.Context)
• func AddArticleAndTag(c *gin.Context)
• func AddBrand(c *gin.Context)
• func DeleteArticle(c *gin.Context)
• func DeleteBrand(c *gin.Context)
• func EditArticle(c *gin.Context)
• func GenerateArticlePoster(c *gin.Context)
• func GetArticle(c *gin.Context)
• func GetArticles(c *gin.Context)
• func GetBrandList(c *gin.Context)
• func GetCourse(c *gin.Context)
• type AddArticleForm
• type EditArticleForm

Constants

const (
	QrCodeURL = "https://github.com/Quons/blog#gin%E7%B3%BB%E5%88%97%E7%9B%AE%E5%BD%95"
)

Functions

func AddArticle

func AddArticle(c *gin.Context)

@Summary 新增文章 @Produce json @Param tag_id query int true "TagID" @Param title query string true "Title" @Param desc query string true "Desc" @Param content query string true "Content" @Param created_by query string true "CreatedBy" @Param state query int true "State" @Success 200 {string} json "{"code":200,"data":{},"msg":"ok"}" @Router /api/v1/articles [post]

func AddArticleAndTag

func AddArticleAndTag(c *gin.Context)

@Summary 新增文章和标签 @Produce json @Success 200 {string} json "{"code":200,"data":{},"msg":"ok"}" @Router /api/v1/articleAndTag [get]

func AddBrand

func AddBrand(c *gin.Context)

@Tags 添加品牌 @Summary 添加品牌 @Description 添加品牌 @Produce json @accept application/x-www-form-urlencoded @Param name formData string true "品牌名称" @Success 99999 "ok" @Failure 10000 {string} json "{"code":10000,"data":{},"msg":"服务器错误"}" @Failure 20000 {string} json "{"code":20000,"data":{},"msg":"参数错误"}" @Router /api/v1/getCourse [post]

func DeleteArticle

func DeleteArticle(c *gin.Context)

@Summary 删除文章 @Produce json @Param id param int true "ID" @Success 200 {string} json "{"code":200,"data":{},"msg":"ok"}" @Failure 200 {string} json "{"code":400,"data":{},"msg":"请求参数错误"}" @Router /api/v1/articles/{id} [delete]

func DeleteBrand

func DeleteBrand(c *gin.Context)

@Tags 删除品牌 @Summary 删除品牌 @Description 添加品牌 @Produce json @accept application/x-www-form-urlencoded @Param name formData string true "品牌名称" @Success 99999 "ok" @Failure 10000 {string} json "{"code":10000,"data":{},"msg":"服务器错误"}" @Failure 20000 {string} json "{"code":20000,"data":{},"msg":"参数错误"}" @Router /api/v1/getCourse [post]

func EditArticle

func EditArticle(c *gin.Context)

@Summary 修改文章 @Produce json @Param id param int true "ID" @Param tag_id query string false "TagID" @Param title query string false "Title" @Param desc query string false "Desc" @Param content query string false "Content" @Param modified_by query string true "ModifiedBy" @Param state query int false "State" @Success 200 {string} json "{"code":200,"data":{},"msg":"ok"}" @Failure 200 {string} json "{"code":400,"data":{},"msg":"请求参数错误"}" @Router /api/v1/articles/{id} [put]

func GenerateArticlePoster

func GenerateArticlePoster(c *gin.Context)

func GetArticle

func GetArticle(c *gin.Context)

@Tags 文章 @Summary 获取单个文章 @Produce json @Param id param int true "ID" @Success 200 {string} json "{"code":200,"data":{"id":3,"created_on":1516937037,"modified_on":0,"tag_id":11,"tag":{"id":11,"created_on":1516851591,"modified_on":0,"name":"312321","created_by":"4555","modified_by":"","state":1},"content":"5555","created_by":"2412","modified_by":"","state":1},"msg":"ok"}" @Router /api/v1/articles/{id} [get]

func GetArticles

func GetArticles(c *gin.Context)

@Summary 获取多个文章 @Produce json @Param tag_id query int false "TagID" @Param token query string false "Token" @Param state query int false "State" @Param created_by query int false "CreatedBy" @Success 200 {string} json "{"code":200,"data":[{"id":3,"created_on":1516937037,"modified_on":0,"tag_id":11,"tag":{"id":11,"created_on":1516851591,"modified_on":0,"name":"312321","created_by":"4555","modified_by":"","state":1},"content":"5555","created_by":"2412","modified_by":"","state":1}],"msg":"ok"}" @Router /api/v1/articles [get]

func GetBrandList

func GetBrandList(c *gin.Context)

@Tags 获取品牌列表 @Summary 获取品牌列表 @Description 添加品牌 @Produce json @accept application/x-www-form-urlencoded @Success 99999 "ok" @Failure 10000 {string} json "{"code":10000,"data":{},"msg":"服务器错误"}" @Failure 20000 {string} json "{"code":20000,"data":{},"msg":"参数错误"}" @Router /api/v1/getCourse [post]

func GetCourse

func GetCourse(c *gin.Context)

@Tags 课程 @Summary 获取单个课程 @Description 获取单个课程description @Produce json @accept application/x-www-form-urlencoded @Param token formData string true "用户token" @Param courseId formData int true "课程ID" @Success 200 {object} vo.CourseVo @Failure 10000 {string} json "{"code":10000,"data":{},"msg":"服务器错误"}" @Failure 20000 {string} json "{"code":20000,"data":{},"msg":"参数错误"}" @Router /api/v1/getCourse [post]

Types

type AddArticleForm

type AddArticleForm struct {
	TagID         int    `form:"tag_id" valid:"Required;Min(1)"`
	Title         string `form:"title" valid:"Required;MaxSize(100)"`
	Desc          string `form:"desc" valid:"Required;MaxSize(255)"`
	Content       string `form:"content" valid:"Required;MaxSize(65535)"`
	CreatedBy     string `form:"created_by" valid:"Required;MaxSize(100)"`
	CoverImageURL string `form:"cover_image_url" valid:"Required;MaxSize(255)"`
	State         int    `form:"state" valid:"Range(0,1)"`
}

type EditArticleForm

type EditArticleForm struct {
	ID            int    `form:"id" valid:"Required;Min(1)"`
	TagID         int    `form:"tag_id" valid:"Required;Min(1)"`
	Title         string `form:"title" valid:"Required;MaxSize(100)"`
	Desc          string `form:"desc" valid:"Required;MaxSize(255)"`
	Content       string `form:"content" valid:"Required;MaxSize(65535)"`
	ModifiedBy    string `form:"modified_by" valid:"Required;MaxSize(100)"`
	CoverImageURL string `form:"cover_image_url" valid:"Required;MaxSize(255)"`
	State         int    `form:"state" valid:"Range(0,1)"`
}

EditArticleForm 编辑