web

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2022 License: MIT Imports: 18 Imported by: 0

README

AnimeGo WEB Api接口文档

响应代码

code值所代码含义

200 成功
300 失败
403 鉴权失败
500 服务端未知错误

鉴权

HTPP请求Header中,Access-Key为SHA256后的access_key

测试连通

GET /ping

响应
pong bool 默认为true
time int64 AnimeGo所在主机当前时间

下载项目

POST /api/rss

请求
source string 来源
rss object 订阅信息
    url string 订阅链接
is_select_ep bool 是否选中部分ep
ep_links []string 选中的ep链接数组

上传插件配置

POST /api/plugin/config

请求
name string 插件名,如`filter/default.js`
data string 配置文件数据,json格式转成的base64字符串

获取插件配置

GET /api/plugin/config

请求
name string 插件名,如`filter/default.js`
响应
name string 插件名,如`filter/default.js`
data string 配置文件数据,json格式转成的base64字符串

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Debug bool
)

Functions

func Cors

func Cors() gin.HandlerFunc

Cors 跨域中间件

func GinLogger

func GinLogger(logger *zap.SugaredLogger) gin.HandlerFunc

GinLogger 接收gin框架默认的日志

func GinRecovery

func GinRecovery(logger *zap.SugaredLogger, stack bool, response func(*gin.Context, interface{})) gin.HandlerFunc

GinRecovery recover掉项目可能出现的panic

func Init

func Init(opt *InitOptions)

func KeyAuth

func KeyAuth() gin.HandlerFunc

KeyAuth 鉴权

func Ping

func Ping(c *gin.Context)

func PluginConfigGet

func PluginConfigGet(c *gin.Context)

func PluginConfigPost

func PluginConfigPost(c *gin.Context)

func Rss

func Rss(c *gin.Context)

func Run

func Run(ctx context.Context)

Types

type InitOptions

type InitOptions struct {
	Debug bool
}

type PluginConfigDownloadRequest

type PluginConfigDownloadRequest struct {
	PluginRequest
}

type PluginConfigResponse

type PluginConfigResponse struct {
	PluginResponse
	Data string `json:"data"` //base64编码后的数据
}

type PluginConfigUploadRequest

type PluginConfigUploadRequest struct {
	PluginRequest
	Data string `json:"data" binding:"required"` //base64格式的文本数据
}

type PluginRequest

type PluginRequest struct {
	Name string `json:"name" form:"name" binding:"required"` //插件文件名
}

func (PluginRequest) CheckName

func (p PluginRequest) CheckName() error

CheckName 检查插件名

type PluginResponse

type PluginResponse struct {
	Name string `json:"name"`
}

type Response

type Response struct {
	Code int         `json:"code"`
	Msg  string      `json:"msg"`
	Data interface{} `json:"data,omitempty"`
}

Response format

func ErrDeny

func ErrDeny(msg string, data ...interface{}) (int, Response)

ErrDeny 返回一个没有权限的结果格式

func ErrIpt

func ErrIpt(msg string, data ...interface{}) (int, Response)

ErrIpt 返回一个输入错误的结果格式

func ErrJwt

func ErrJwt(msg string, data ...interface{}) (int, Response)

ErrJwt 返回一个通过验证的结果格式

func ErrOpt

func ErrOpt(msg string, data ...interface{}) (int, Response)

ErrOpt 返回一个输出错误的结果格式

func ErrSvr

func ErrSvr(msg string, data ...interface{}) (int, Response)

ErrSvr 返回一个服务端错误的结果格式

func Ext

func Ext(msg string, data ...interface{}) (int, Response)

Ext 返回一个其他约定的结果格式

func Fail

func Fail(msg string, data ...interface{}) (int, Response)

Fail 返回一个失败标识的结果格式

func Page

func Page(msg string, items interface{}, count int) (int, Response)

Page 返回一个带有分页数据的结果格式

func Succ

func Succ(msg string, data ...interface{}) (int, Response)

Succ 返回一个成功标识的结果格式

type SelectEpRequest

type SelectEpRequest struct {
	Source string `json:"source" binding:"required"`
	Rss    struct {
		Url string `json:"url" binding:"required"`
	} `json:"rss" binding:"required"`
	IsSelectEp bool     `json:"is_select_ep"`
	EpLinks    []string `json:"ep_links"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL