v1

Documentation

Index

• Constants
• func AddArticle(c *gin.Context)
• func AddTag(c *gin.Context)
• func DeleteArticle(c *gin.Context)
• func DeleteTag(c *gin.Context)
• func EditArticle(c *gin.Context)
• func EditTag(c *gin.Context)
• func ExportTag(c *gin.Context)
• func GenerateArticlePoster(c *gin.Context)
• func GetArticle(c *gin.Context)
• func GetArticles(c *gin.Context)
• func GetTags(c *gin.Context)
• func ImportTag(c *gin.Context)
• type AddArticleForm
• type AddTagForm
• type EditArticleForm
• type EditTagForm

Constants

const (
	QRCODE_URL = "http://192.168.43.169:8080/upload/images/4c50eef3bdaf0b4164ce179e576f2b2d.jpg"
)

Functions

func AddArticle

func AddArticle(c *gin.Context)

AddArticle 新增文章

@Summary	Add article
@Produce	json
@Param		tag_id		body		int		true	"TagID"
@Param		title		body		string	true	"Title"
@Param		desc		body		string	true	"Desc"
@Param		content		body		string	true	"Content"
@Param		created_by	body		string	true	"CreatedBy"
@Param		state		body		int		true	"State"
@Success	200			{object}	app.Response
@Failure	500			{object}	app.Response
@Router		/api/v1/articles [post]

func AddTag

func AddTag(c *gin.Context)

AddTag

@Summary	Add article tag
@Produce	json
@Param		name		body		string	true	"Name"
@Param		state		body		int		false	"State"
@Param		created_by	body		int		false	"CreatedBy"
@Success	200			{object}	app.Response
@Failure	500			{object}	app.Response
@Router		/api/v1/tags [post]

func DeleteArticle

func DeleteArticle(c *gin.Context)

DeleteArticle

@Summary	Delete article
@Produce	json
@Param		id	path		int	true	"ID"
@Success	200	{object}	app.Response
@Failure	500	{object}	app.Response
@Router		/api/v1/articles/{id} [delete]

func DeleteTag

func DeleteTag(c *gin.Context)

DeleteTag

@Summary	Delete article tag
@Produce	json
@Param		id	path		int	true	"ID"
@Success	200	{object}	app.Response
@Failure	500	{object}	app.Response
@Router		/api/v1/tags/{id} [delete]

func EditArticle

func EditArticle(c *gin.Context)

EditArticle

@Summary	Update article
@Produce	json
@Param		id			path		int		true	"ID"
@Param		tag_id		body		string	false	"TagID"
@Param		title		body		string	false	"Title"
@Param		desc		body		string	false	"Desc"
@Param		content		body		string	false	"Content"
@Param		modified_by	body		string	true	"ModifiedBy"
@Param		state		body		int		false	"State"
@Success	200			{object}	app.Response
@Failure	500			{object}	app.Response
@Router		/api/v1/articles/{id} [put]

func EditTag

func EditTag(c *gin.Context)

EditTag

@Summary	Update article tag
@Produce	json
@Param		id			path		int		true	"ID"
@Param		name		body		string	true	"Name"
@Param		state		body		int		false	"State"
@Param		modified_by	body		string	true	"ModifiedBy"
@Success	200			{object}	app.Response
@Failure	500			{object}	app.Response
@Router		/api/v1/tags/{id} [put]

func ExportTag

func ExportTag(c *gin.Context)

ExportTag

@Summary	Export article tag
@Produce	json
@Param		name	body		string	false	"Name"
@Param		state	body		int		false	"State"
@Success	200		{object}	app.Response
@Failure	500		{object}	app.Response
@Router		/api/v1/tags/export [post]

func GenerateArticlePoster

func GenerateArticlePoster(c *gin.Context)

func GetArticle

func GetArticle(c *gin.Context)

GetArticle

@Summary	Get a single article
@Produce	json
@Param		id	path		int	true	"ID"
@Success	200	{object}	app.Response
@Failure	500	{object}	app.Response
@Router		/api/v1/articles/{id} [get]

func GetArticles

func GetArticles(c *gin.Context)

GetArticles 获取多个文章

@Summary	Get multiple articles
@Produce	json
@Param		tag_id		body		int	false	"TagID"
@Param		state		body		int	false	"State"
@Param		created_by	body		int	false	"CreatedBy"
@Success	200			{object}	app.Response
@Failure	500			{object}	app.Response
@Router		/api/v1/articles [get]

func GetTags

func GetTags(c *gin.Context)

GetTags

@Summary	Get multiple article tags
@Produce	json
@Param		name	query		string	false	"Name"
@Param		state	query		int		false	"State"
@Success	200		{object}	app.Response
@Failure	500		{object}	app.Response
@Router		/api/v1/tags [get]

func ImportTag

func ImportTag(c *gin.Context)

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 AddTagForm

type AddTagForm struct {
	Name      string `form:"name" valid:"Required;MaxSize(100)"`
	CreatedBy string `form:"created_by" valid:"Required;MaxSize(100)"`
	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)"`
}

type EditTagForm

type EditTagForm struct {
	ID         int    `form:"id" valid:"Required;Min(1)"`
	Name       string `form:"name" valid:"Required;MaxSize(100)"`
	ModifiedBy string `form:"modified_by" valid:"Required;MaxSize(100)"`
	State      int    `form:"state" valid:"Range(0,1)"`
}