webhook

README

webhook

✨ 你说得对，但是 webhook 是基于 weibo-webhook 改良的分布式博文收集终端 ✨

文档 · 下载

使用

我没写～(∠・ω< )

Documentation

Index

• Variables
• func Authorize(c *gin.Context)
• func Cors(c *gin.Context)
• func Debug(r *Config)
• func Default[T comparable](a *T, b T)
• func Failed(c *gin.Context, code int, message string, data ...any)
• func FetchFile(c *gin.Context)
• func GetBranches(c *gin.Context)
• func GetComments(c *gin.Context)
• func GetPosts(c *gin.Context)
• func GetToken(c *gin.Context)
• func GetUser(c *gin.Context) *user.User
• func Register(c *gin.Context)
• func Release(r *Config)
• func Run(r *Config)
• func Submit(c *gin.Context)
• func Succeed(c *gin.Context, data ...any)
• type Config
• type Cycle
  • func (c Cycle) AfterAdmin(r *Config)
  • func (c Cycle) AfterAuthorize(r *Config)
  • func (c Cycle) BeforeAuthorize(r *Config)
  • func (c Cycle) OnAdmin(r *Config)
  • func (c Cycle) OnAuthorize(r *Config)
  • func (c Cycle) OnCors(r *Config)
  • func (c Cycle) OnCreate(r *Config)
  • func (c Cycle) OnStatic(r *Config)
• type Github
  • func (g Github) AllExists(sha []byte) bool
  • func (g Github) Clone(folder string) error
  • func (g *Github) GetLatestCommit() ([]byte, error)
  • func (g Github) Write(sha []byte) error
• type LifeCycle
• type Network
  • func (n Network) Addr() string
• type Resource
  • func (r Resource) IndexUpdate() (err error)
  • func (r Resource) List() any
  • func (r Resource) ToIndex() string
  • func (r Resource) ToPostsDB() gorm.Dialector
  • func (r Resource) ToPublic(files ...string) string
  • func (r Resource) ToRoot(files ...string) string
  • func (r Resource) ToUsersDB() gorm.Dialector

Variables

var (
	GIT = "https://github.com/"
	API = "https://api.github.com/repos/"
)

Functions

func Authorize

func Authorize(c *gin.Context)

验证授权

func Cors

func Cors(c *gin.Context)

解决跨域问题

参考: https://blog.csdn.net/u011866450/article/details/126958238

func Debug

func Debug(r *Config)

测试版

func Default

func Default[T comparable](a *T, b T)

设置默认值

func Failed

func Failed(c *gin.Context, code int, message string, data ...any)

返回错误信息

func FetchFile

func FetchFile(c *gin.Context)

获取参数 https://blog.csdn.net/weixin_52690231/article/details/124109518 返回文件 https://blog.csdn.net/kilmerfun/article/details/123943070 重定向至 https://www.ngui.cc/el/3757797.html?action=onClick

func GetBranches

func GetBranches(c *gin.Context)

获取所有分支

func GetComments

func GetComments(c *gin.Context)

获取所有评论

func GetPosts

func GetPosts(c *gin.Context)

获取 begin 与 end 时间范围内的所有博文

func GetToken

func GetToken(c *gin.Context)

func GetUser

func GetUser(c *gin.Context) *user.User

读取用户

func Register

func Register(c *gin.Context)

注册

func Release

func Release(r *Config)

发行版

func Run

func Run(r *Config)

func Submit

func Submit(c *gin.Context)

提交博文

func Succeed

func Succeed(c *gin.Context, data ...any)

返回成功数据

Types

type Config

type Config struct {
	// 资源
	Resource
	// 网络
	Network
	// 生命周期
	LifeCycle
	// 引擎
	*gin.Engine
}

webhook 配置

type Cycle

type Cycle struct{}

func (Cycle) AfterAdmin

func (c Cycle) AfterAdmin(r *Config)

func (Cycle) AfterAuthorize

func (c Cycle) AfterAuthorize(r *Config)

func (Cycle) BeforeAuthorize

func (c Cycle) BeforeAuthorize(r *Config)

func (Cycle) OnAdmin

func (c Cycle) OnAdmin(r *Config)

func (Cycle) OnAuthorize

func (c Cycle) OnAuthorize(r *Config)

func (Cycle) OnCors

func (c Cycle) OnCors(r *Config)

func (Cycle) OnCreate

func (c Cycle) OnCreate(r *Config)

func (Cycle) OnStatic

func (c Cycle) OnStatic(r *Config)

type Github

type Github struct {
	Username   string
	Repository string
	Branche    string
	Commit     struct {
		Sha []byte `json:"sha"`
	} `json:"commit"`

	Path    string
	HTML    string
	Version string
	// contains filtered or unexported fields
}

func (Github) AllExists

func (g Github) AllExists(sha []byte) bool

先判断文件夹存不存在 再判断主页存不存在 再判断版本对不对

func (Github) Clone

func (g Github) Clone(folder string) error

克隆到文件夹

func (*Github) GetLatestCommit

func (g *Github) GetLatestCommit() ([]byte, error)

获取最新提交

func (Github) Write

func (g Github) Write(sha []byte) error

写入版本

type LifeCycle

type LifeCycle interface {
	// 初始化
	OnCreate(*Config)
	// 跨域设置
	OnCors(*Config)
	// 静态资源绑定
	OnStatic(*Config)
	// 无鉴权接口
	BeforeAuthorize(*Config)
	// 鉴权
	OnAuthorize(*Config)
	// 有鉴权接口
	AfterAuthorize(*Config)
	// 鉴定管理员权限
	OnAdmin(*Config)
	// 管理员接口
	AfterAdmin(*Config)
}

type Network

type Network struct {
	// 服务器启动 IP
	Url string
	// 启动端口
	Port int
}

网络

func (Network) Addr

func (n Network) Addr() string

type Resource

type Resource struct {
	// 文件夹路径
	Path string
	// 公开子文件夹
	Public struct {
		// 子文件路径
		Path string
		// posts 数据库文件名
		Posts string
		// Github 主页
		Github Github
	}
	// users 数据库名
	Users string
}

资源文件夹

func (Resource) IndexUpdate

func (r Resource) IndexUpdate() (err error)

主页更新

func (Resource) List

func (r Resource) List() any

func (Resource) ToIndex

func (r Resource) ToIndex() string

func (Resource) ToPostsDB

func (r Resource) ToPostsDB() gorm.Dialector

func (Resource) ToPublic

func (r Resource) ToPublic(files ...string) string

func (Resource) ToRoot

func (r Resource) ToRoot(files ...string) string

func (Resource) ToUsersDB

func (r Resource) ToUsersDB() gorm.Dialector