diff --git a/doc/api/version.example.json b/doc/api/version.example.json new file mode 100644 index 0000000..0eff326 --- /dev/null +++ b/doc/api/version.example.json @@ -0,0 +1,4 @@ +{ + "$schema": "version.json", + "version": [1, 0, 0, 0] +} \ No newline at end of file diff --git a/doc/api/version.json b/doc/api/version.json new file mode 100644 index 0000000..aa738d0 --- /dev/null +++ b/doc/api/version.json @@ -0,0 +1,17 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "$id": "https://github.com/lifegpc/pixiv_downloader/raw/master/doc/api/version.json", + "title": "Server version", + "type": "object", + "properties": { + "version": { + "description": "The version of the API", + "type": "array", + "items": { + "type": "integer" + }, + "maxItems": 4, + "minItems": 4 + } + } +} diff --git a/doc/api/version.md b/doc/api/version.md new file mode 100644 index 0000000..ec7ee93 --- /dev/null +++ b/doc/api/version.md @@ -0,0 +1,7 @@ +[中文(简体)](version.zh_CN.md) +# Get server version +* route: `/version` or `/api/version` +* method: `GET` or `POST` +* auth: Not needed +* [Example](version.example.json) +* [JSON schema](version.json) diff --git a/doc/api/version.zh_CN.md b/doc/api/version.zh_CN.md new file mode 100644 index 0000000..e5fad02 --- /dev/null +++ b/doc/api/version.zh_CN.md @@ -0,0 +1,7 @@ +[English](version.md) +# 获取服务器版本 +* 路径: `/version` 或 `/api/version` +* 方法: `GET` 或 `POST` +* 鉴权: 无需 +* [示例](version.example.json) +* [JSON Schema](version.json)