aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/API.rst
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2024-08-02 00:08:13 +0800
committer简律纯 <i@jyunko.cn>2024-08-02 00:08:13 +0800
commit70856b64d46b2c7d4df9ba1e59e6e2992dc1d824 (patch)
tree2f3c91feee937a3c2a6e8391e34021a349137c52 /docs/source/API.rst
parent5ad26d4cb60999972ac0130fb55376b51952b16d (diff)
downloadecho-70856b64d46b2c7d4df9ba1e59e6e2992dc1d824.tar.gz
echo-70856b64d46b2c7d4df9ba1e59e6e2992dc1d824.zip
docs!: rebuild with readthedocs and sphinx-build
Diffstat (limited to 'docs/source/API.rst')
-rw-r--r--docs/source/API.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/source/API.rst b/docs/source/API.rst
new file mode 100644
index 0000000..9022bc2
--- /dev/null
+++ b/docs/source/API.rst
@@ -0,0 +1,26 @@
+---
+title: API Reference
+---
+
+## ES 1.0
+
+### API
+
+#### 1. `get_version`
+
+| Method | field | type | notes |
+| :-: | :-: | :--: | :----: |
+| GET | 无 | | |
+
+| Output | field | type | notes |
+| :-: | :-: | :--: | :----: |
+| | ESV | list | 符合语义化版本2.0.0规范的数组[^1] |
+[^1]: https://github.com/HydroRoll-Team/echo/blob/main/docs/index.md#版本
+
+示例:
+
+```json
+{
+ "ESV": [1, 0, 0]
+}
+```