girineko/McStatus-API
1
0
Fork 0
mirror of https://github.com/Murasame-Dev/McStatus-API.git synced 2025-12-14 12:18:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
McStatus-API/README.md
Murasame Noa 099a79fe5f
重写成 FastAPI (#3) 
* 重写成FastAPI

* 修改依赖相关配置
- pyproject `uvicorn[standard] -> fastapi[standard]`
- requirements.txt 使用 `uv export` 生成
- Dockerfile 换用 `python:3.13`
- README pip 安装增加版本提示

---------

Co-authored-by: wyf9 <wyf9@wyf9.top>
2025-08-28 11:29:23 +08:00

1.7 KiB
Raw Permalink Blame History

McStatus-API

这是一个 FastAPI 项目，主要封装了 mcstatus 包，用于查询 Minecraft 服务器状态，支持Java和基岩，以及附带其他小特性！

💻用法

此项目的页面模板正在筹备中，敬请等待！

  • GET /java?ip=<IP> - (Required) - 查询 Java 版服务器状态
  • GET - /bedrock?ip=<IP> - (Required) - 查询基岩版服务器状态
  • Get - /docs - FastAPI 的内建文档

📦安装&▶启动

以下提到的方法 任选其一 即可 （确保你有Python 3.10或以上的环境）

uv 
uv run app.py
pdm 
pdm install
pdm run app.py
pip 
# 请确保使用 Python >= 3.13!
pip install -r requirements.txt
python app.py
docker 
docker build -t mcstatus-api .
docker run --name mcstatus-api -p 8000:8000 -d mcstatus-api

或者，你也可以使用这个编译好的镜像：registry.cn-guangzhou.aliyuncs.com/ineko-docker/mcstatus-api:latest

🖊下一步计划

  1. 添加配置文件
  2. 添加一个基于此项目的服务端(他可能只是一个API Caller，或者是一个Websocket服务器？)
    服务端可以调用多个API，并将其返回的信息进行合并并输出，旨在用于检查不同地区的延迟
  3. 添加是否默认使用 SRV 解析的变量
  4. 等一切尘埃落定后，我会考虑使用 FastAPI --- 已完成

📞 联系

TG群组：点此加入
吹水群：1049319982
邮箱：congyu@sbhfy.cn