Skip to content

stephen-zeng/urlAPI

Repository files navigation

项目功能计划

  • 后台管理
  • 安全检测
  • 文字生成
  • 图片生成
  • 随机图片
  • 网页缩略图

安全检测项目

  • 防盗链 (Referer) 检测
  • IP滥用检测
  • 后台登录IP限制

API本体使用

文字生成

格式:https://api.example.com/txt? + 参数1=值1&参数2=值2&参数3=值3,参数如下

参数名 参数值 说明
prompt(必填) laugh, poem, sentence, 其他提示词 laught为笑话,poem是诗句(创作),sentence是鸡汤
format(选填) json, txt 默认直接跳转图片,json为输出JSON格式
api(选填) alibaba/openai/deepseek/otherapi 在后台可以设置默认API
model(选填) * 在后台可以设置默认模型
more(选填) * 添加更多信息,便于记录和筛选
  • 图片上使用的字体是得意黑:)

图片生成

格式:https://api.example.com/img? + 参数1=值1&参数2=值2&参数3=值3,参数如下

参数名 参数值 说明
prompt(必填) / 提示词
format(选填) json 默认直接跳转,json为输出JSON格式
api(选填) alibaba, openai 在后台可以设置默认API
size(选填) / 后台可以设置默认大小,自定义的话参见对应的文档填入
more(选填) * 添加更多信息,便于记录和筛选

随机图片

格式:https://api.example.com/rand? + 参数1=值1&参数2=值2&参数3=值3,参数如下

参数名 参数值 说明
api(选填) github, gitee 使用的仓库
user(必填) / 仓库主人的用户名
repo(必填) / 仓库名称
format(选填) json 默认直接跳转,json为输出JSON
more(选填) * 添加更多信息,便于记录和筛选

请注意,仓库内不要出现文件夹,否则会添加失败

网页缩略图

格式:https://api.example.com/rand? + 参数1=值1&参数2=值2&参数3=值3,参数如下

参数名 参数值 说明
img(必填) URL 网页缩略图
format(选填) json 默认返回图片,json为返回JSON
more(选填) * 添加更多信息,便于记录和筛选

参考文档

后台管理

地址:https://api.example.com/dash

访问情况

  • 上半部分为访问情况,单击记录可以查看具体信息,具体信息中单击对应信息可复制
  • 下半部分为分类,单击分类中具体项目可以筛选,刷新以重置

接口设置

这里设置对接OpenAI,阿里巴巴等的接口,包括默认模型选择,API Key等等。

功能设置

有安全,文字,图像,随机图片,网页五个选项,具体讲解如图(新版本可能会有一点差异):

启动设置

启动参数(可选)

  • clear - 清空任务
  • logout - 清空登录凭证
  • repwd - 重置后台登录密码
  • port .... - 将端口设置为....,默认端口是2233
  • clear_ip_restriction - 清除后台登录IP限制 反向代理的时候注意将发送域名设置为$http_host

注意,初始密码为123456,请注意及时修改

Demo

一些可能生成错误的原因

  • 服务器与上游API的连接问题,比如国内服务器不经过特殊手段无法连接OpenAI的服务器。
  • 还有出现的问题欢迎Issue

Docker部署

可以使用项目中的Dockerfile自行构建,也可以使用下面的命令来运行

docker run -d --name urlapi -p %EXPOSE_PORT%:2233 -v %LOCAL_DATA_PLACE%:/app/assets 0w0w0/urlapi:latest

# e.g
docker run -d --name urlapi -p 8080:2233 -v /home/stephenzeng/dockerData/urlAPI:/app/assets 0w0w0/urlapi:latest
  • 镜像目前latest和具体版本号两种tag,建议使用latest
  • arm版本的镜像为0w0w0/urlapi-arm

二进制文件

可以到action里面寻找最新的build,也可以去release里面寻找稳定的build

注册为systemctl服务

下面是/etc/systemd/system/urlAPI.service模板

[Unit]
Description = urlAPI
After = network.target syslog.target
Wants = network.target

[Service]
Type = simple
WorkingDirectory = /root/urlAPI/
ExecStart = /root/urlAPI/urlAPI port 2233
Restart = on-failure


[Install]
WantedBy = multi-user.target

之后运行systemctl daemon-reload && systemctl enable --now urlAPI即可注册为开机启动的服务

About

将一些功能集成在API内,可以供博客生成更加独特的内容

Resources

License

Stars

Watchers

Forks

Packages

No packages published