# 7749-api-docs
**Repository Path**: jun-wan/7749-api-docs
## Basic Information
- **Project Name**: 7749-api-docs
- **Description**: 7749-api-docs
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-04-27
- **Last Updated**: 2026-04-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## 功能
- 首页品牌展示与 API Base URL 一键复制
- OpenAI 兼容接口文档
- Cherry Studio、CC Switch、Lobe Chat、AionUI、OpenCat 配置说明
- Claude Code、Codex、Gemini CLI 接入说明
- 在线聊天测试:`/v1/chat/completions`
- 在线绘图测试:`/v1/images/generations`
- 绘图耗时、usage 信息、图片预览和下载
- 本地搜索、暗色模式、响应式文档布局
## 接口信息
```text
Base URL: https://api.774966.xyz/v1
```
对话模型:
```text
gpt-5.5
gpt-5.4
gpt-5.4-mini
gpt-5.3-codex
```
绘图模型:
```text
gpt-image-2
```
## 密钥说明
在线测试页不会把 API Key 上传到文档站服务器。
API Key 只保存在当前浏览器的 `localStorage` 中,并且页面提供“清除密钥”按钮。只有用户点击测试请求时,浏览器才会把密钥作为 `Authorization` 请求头发送到 `https://api.774966.xyz/v1`。
## 开发
安装依赖:
```bash
pnpm install
```
本机启动:
```bash
pnpm docs:dev
```
局域网启动:
```bash
pnpm docs:dev:lan
```
默认局域网端口是 `5173`。
## 构建
```bash
pnpm docs:build
```
构建产物在:
```text
docs/.vitepress/dist
```
预览构建结果:
```bash
pnpm docs:preview
```
## 目录结构
```text
docs/
index.md 首页
api/ API 接入文档
billing/ 充值与用量
clients/ 客户端配置
deploy/ AI 编程工具部署
guide/ 注册与 Key 管理
playground/ 在线测试页面
support/ FAQ 与故障排查
.vitepress/
config.mts 站点导航、侧边栏、搜索、页脚
theme/
components/ 自定义 Vue 组件
custom.css 自定义样式
```
## 修改文档
新增或修改页面时,直接编辑 `docs/**/*.md`。
如果新增页面需要出现在顶部导航或左侧菜单中,修改:
```text
docs/.vitepress/config.mts
```
首页的 API Base URL 复制条、在线聊天、在线绘图等交互能力在:
```text
docs/.vitepress/theme/components/
```
## 提交规范
详细规则见:[Git 提交规则](docs/git-commit-rules.md)。
提交注释必须使用中文,格式如下:
```text
两位序号-改动类型-改动内容
```
示例:
```text
01-新增-初始化7749 API文档站
02-优化-首页API地址复制模块
03-修复-绘图测试耗时显示问题
04-发布-更新线上文档版本
```
规则:
- 序号使用两位数字,从 `01` 开始递增。
- 改动类型使用中文,例如:`新增`、`优化`、`修复`、`删除`、`重构`、`发布`、`文档`。
- 改动内容必须使用中文,简洁说明本次提交做了什么。
- 不使用英文提交注释,不使用拼音提交注释。
启用本地提交模板和校验:
```bash
git config core.hooksPath .githooks
git config commit.template .gitmessage.txt
```
## 部署
推荐使用 Vercel、Cloudflare Pages、Netlify、Gitee Pages 或自己的静态服务器。
构建命令:
```bash
pnpm docs:build
```
发布目录:
```text
docs/.vitepress/dist
```
## Docker 一键部署
项目已内置多阶段 `Dockerfile`,构建阶段使用 VitePress 生成静态文件,运行阶段使用 nginx 托管。
### 使用 docker run
如果已经有远程镜像,服务器可以直接运行:
```bash
docker run -d \
--name 7749-api-docs \
--restart unless-stopped \
-p 8080:80 \
tannic666/7749-api-docs:latest
```
访问:
```text
http://localhost:8080
```
更新镜像:
```bash
docker pull tannic666/7749-api-docs:latest
docker rm -f 7749-api-docs
docker run -d \
--name 7749-api-docs \
--restart unless-stopped \
-p 8080:80 \
tannic666/7749-api-docs:latest
```
### 使用 docker compose
如果希望在服务器上直接从源码构建,使用:
```bash
docker compose up -d --build
```
默认访问端口:
```text
http://localhost:8080
```
自定义端口:
```bash
PORT=80 docker compose up -d --build
```
停止服务:
```bash
docker compose down
```
## 双架构镜像构建与推送
支持通过 Docker Buildx 构建并推送 `linux/amd64` 和 `linux/arm64` 双架构镜像。
推送前先登录你的镜像仓库:
```bash
docker login
```
Windows PowerShell:
```powershell
.\scripts\docker-build-push.ps1 -Image docker.io/tannic666/7749-api-docs -Tag latest
```
Linux / macOS:
```bash
IMAGE=docker.io/tannic666/7749-api-docs TAG=latest sh scripts/docker-build-push.sh
```
默认平台:
```text
linux/amd64,linux/arm64
```
推送完成后,服务器可以直接使用远程镜像:
```bash
docker run -d \
--name 7749-api-docs \
--restart unless-stopped \
-p 8080:80 \
tannic666/7749-api-docs:latest
```