api

package

v0.5.2 Latest Latest Go to latest Published: Dec 22, 2022 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wetor/AnimeGo

Links

Open Source Insights

Documentation ¶

Index ¶

func Config(c *gin.Context)
func Ping(c *gin.Context)
func PluginConfigGet(c *gin.Context)
func PluginConfigPost(c *gin.Context)
func Rss(c *gin.Context)
func SHA256(c *gin.Context)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Config ¶

func Config(c *gin.Context)

Config godoc

@Summary 获取设置
@Description 将待下载项组合成rss发送给AnimeGo
@Tags config
@Accept  json
@Produce  json
@Param type query webModels.ConfigGetRequest true "获取设置内容"
@Success 200 {object} webModels.Response{data=webModels.ConfigResponse}
@Failure 300 {object} webModels.Response
@Security ApiKeyAuth
@Router /api/config [get]

func Ping ¶

func Ping(c *gin.Context)

Ping godoc

@Summary Ping
@Description Pong
@Tags web
@Accept  json
@Produce  json
@Success 200 {object} webModels.Response
@Router /ping [get]

func PluginConfigGet ¶

func PluginConfigGet(c *gin.Context)

PluginConfigGet godoc

@Summary 获取插件配置
@Description 从AnimeGo中获取当前插件的配置
@Description 插件名为不包含 'plugin' 的路径
@Description 插件名可以忽略'.js'后缀；插件名也可以使用上层文件夹名，会自动寻找文件夹内部的 'main.js' 或 'plugin.js'
@Description 如传入 'test'，会依次尝试寻找 'plugin/test/main.js', 'plugin/test/plugin.js', 'plugin/test.js'
@Tags plugin
@Accept  json
@Produce  json
@Param name query string true "插件信息"
@Success 200 {object} webModels.Response
@Failure 300 {object} webModels.Response
@Security ApiKeyAuth
@Router /api/plugin/config [get]

func PluginConfigPost ¶

func PluginConfigPost(c *gin.Context)

PluginConfigPost godoc

@Summary 发送插件配置
@Description 将当前插件的配置发送给AnimeGo并保存
@Description 插件名为不包含 'plugin' 的路径
@Description 插件名可以忽略'.js'后缀；插件名也可以使用上层文件夹名，会自动寻找文件夹内部的 'main.js' 或 'plugin.js'
@Description 如传入 'test'，会依次尝试寻找 'plugin/test/main.js', 'plugin/test/plugin.js', 'plugin/test.js'
@Tags plugin
@Accept  json
@Produce  json
@Param plugin body webModels.PluginConfigUploadRequest true "插件信息，data为base64编码后的json文本"
@Success 200 {object} webModels.Response
@Failure 300 {object} webModels.Response
@Security ApiKeyAuth
@Router /api/plugin/config [post]

func Rss ¶

func Rss(c *gin.Context)

Rss godoc

@Summary 发送下载项
@Description 将待下载项组合成rss发送给AnimeGo
@Tags plugin
@Accept  json
@Produce  json
@Param rss body webModels.SelectEpRequest true "组合的rss信息"
@Success 200 {object} webModels.Response
@Failure 300 {object} webModels.Response
@Security ApiKeyAuth
@Router /api/rss [post]

func SHA256 ¶

func SHA256(c *gin.Context)

SHA256 godoc

@Summary SHA256计算
@Description SHA256计算
@Tags web
@Accept  json
@Produce  json
@Param access_key query string true "原文本"
@Success 200 {object} webModels.Response{data=string}
@Router /sha256 [get]

Types ¶

This section is empty.

Source Files ¶

View all Source files

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