增加文档

This commit is contained in:
2022-09-18 13:28:53 +00:00
committed by GitHub
parent ed35ef6e49
commit 59562eaec8
4 changed files with 35 additions and 0 deletions

View File

@@ -0,0 +1,4 @@
{
"$schema": "version.json",
"version": [1, 0, 0, 0]
}

17
doc/api/version.json Normal file
View File

@@ -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
}
}
}

7
doc/api/version.md Normal file
View File

@@ -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)

7
doc/api/version.zh_CN.md Normal file
View File

@@ -0,0 +1,7 @@
[English](version.md)
# 获取服务器版本
* 路径: `/version``/api/version`
* 方法: `GET``POST`
* 鉴权: 无需
* [示例](version.example.json)
* [JSON Schema](version.json)