mirror/blessing-skin-manual
2
0
Fork 0
mirror of https://github.com/bs-community/blessing-skin-manual.git synced 2024-11-27 00:59:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

update API docs

Browse Source
This commit is contained in:
Pig Fang 2020-07-29 18:59:48 +08:00
parent 2ea705074c
commit a36cbbe796
No known key found for this signature in database
GPG Key ID: A8198F548DADA9E2
1 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
man/api/avatars-and-previews.md
View File

@ -78,7 +78,31 @@ GET /avatar/{tid}
可通过响应头的 `Content-Type` 字段来判断图片格式。
## 生成材质预览图
## 根据材质文件 hash 生成头像
通过这个 API，可以生成并返回该材质对应的头像图片并且不需要事先知道材质的 TID。
```
GET /avatar/hash/{hash}
```
其中 `{hash}` 参数为材质文件的 hash 值。
### 参数
| 名称 | 类型 | 描述 |
| ------ | --------- | ------------------------------------------------------------ |
| `size` | `integer` | 头像大小。注意这不是最终生成的图片尺寸大小。 |
| `3d` | `any` | 当此参数存在时，将生成一个类似有「3D」效果的头像，而不是头像的正面图。 |
| `png` | `any` | 当此参数存在时，将返回 PNG 格式图片；否则返回 WebP 格式。（但如果服务器的 GD 扩展不支持 WebP 则仍返回 PNG） |
### 响应
如果材质不存在，返回 404；正常返回 200。
可通过响应头的 `Content-Type` 字段来判断图片格式。
## 根据材质 TID 生成材质预览图
生成并返回材质的正面和背面的预览图。
@ -99,3 +123,25 @@ GET /preview/{tid}
如果材质不存在，返回 404；正常返回 200。
可通过响应头的 `Content-Type` 字段来判断图片格式。
## 根据材质文件 hash 生成材质预览图
生成并返回材质的正面和背面的预览图，并且不需要事先知道材质的 TID。
```
GET /preview/hash/{hash}
```
其中 `{hash}` 参数为材质文件的 hash 值。
### 参数
| 名称 | 类型 | 描述 |
| ----- | ----- | ------------------------------------------------------------ |
| `png` | `any` | 当此参数存在时，将返回 PNG 格式图片；否则返回 WebP 格式。（但如果服务器的 GD 扩展不支持 WebP 则仍返回 PNG） |
### 响应
如果材质不存在，返回 404；正常返回 200。
可通过响应头的 `Content-Type` 字段来判断图片格式。