API 快速开始

您可以使用 PJSK Sticker API 来生成贴纸。

API 端点

用于测试的 API 端点如下：

https://api.parallel-sekai.org/pjsk-sticker

在本地部署成功后，您可以使用以下 URL 进行测试：

http://127.0.0.1:8000/pjsk-sticker?character=miku&text=hello

Docker 部署

使用 Docker 部署 PJSK Sticker API 是最简单快捷的方式。

运行以下命令即可在本地启动一个容器：

docker run -d -p 8000:8000 xiaocaoooo/pjsk-sticker-api:latest

Python 部署

对于更高级的部署或开发需求，推荐使用 Python 进行部署。首先，您需要克隆代码库：

git clone https://github.com/Parallel-SEKAI/PJSK-Sticker-API.git
cd PJSK-Sticker-API

方案一：使用 uv 管理虚拟环境（推荐）

uv 是一个快速的 Python 依赖管理工具。

1. 安装 uv:

pip install uv

2. 创建虚拟环境:

uv venv

3. 安装依赖:

uv sync

4. 启动 API 服务器:

uv run uvicorn api:app --host 0.0.0.0 --port 8000

方案二：使用 venv 管理虚拟环境

这是 Python 标准库提供的虚拟环境管理方式。

1. 创建并激活虚拟环境:

python -m venv venv
source venv/bin/activate  # macOS/Linux
 或 venv\Scripts\activate  # Windows

2. 安装依赖:

pip install .

3. 启动 API 服务器:

uvicorn api:app --host 0.0.0.0 --port 8000

访问 API 文档

• Swagger UI: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redoc