Skip to content

BLxcwg666/NekoAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NekoAPI

A Mixed Node.JS API with Express(Just For Fun
写给我自己用的
如果你看上了某些东西,欢迎搬到你的应用程序中,但是请注明来源,商业用途请提前跟我打招呼

Issues 长期收功能建议

安装

确保环境中有 Node.JS ≥ 18(开发使用 20.8.0
将仓库克隆到本地后使用 npm install 安装依赖
复制 .env.example.env,配置完成后使用 node main.js 运行

配置

以下为 .env 文件的配置

# Express 配置
HOST=0.0.0.0               # 绑定的主机,默认 0.0.0.0,如果仅允许本地访问则改为 127.0.0.1
PORT=443                   # 绑定端口,使用 443 需要启用下面一项并配置 SSL 证书
ENABLE_SSL=true            # 启用本项请确保上一项为非 80 端口,true 为开,false 为关

# SSL 配置
CERT_PATH="./Certs/api.local.cat.pem"                  # SSL 证书路径
CERT_KEY_PATH="./Certs/api.local.cat-key.pem"          # SSL 密钥路径

# API 配置
IP_HEADER=cf-connecting-ip       # 在某些地方会用到,如果你没有使用 CDN 请清空此项,否则将此项设置为你的 CDN 返回的用户真 IP

功能

/random/sticker 从 cdn.xcnya.cn 随机一张贴纸
/net/getip 获取访客 IP,如果通过 Curl Wget 访问直接返回 IP

特性

  • 支持 SSL
  • 支持自定义用户真 IP HTTP 头
  • 访问日志写入 .log 文件

展望未来

  • 集群支持

About

A Mixed Node.JS API with Express(Just For Fun

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published