From fe2db90fc5e2ef709574030bb4c4faddc6ecae00 Mon Sep 17 00:00:00 2001
From: Liang Ding <d@b3log.org>
Date: Fri, 17 Sep 2021 22:07:55 +0800
Subject: [PATCH] :memo: API

---
 API.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/API.md b/API.md
index a26202771..d208394c0 100644
--- a/API.md
+++ b/API.md
@@ -15,6 +15,7 @@
     * [重命名文档](#重命名文档)
     * [删除文档](#删除文档)
     * [移动文档](#移动文档)
+    * [根据路径获取人类可读路径](#根据路径获取人类可读路径)
 * [资源文件](#资源文件)
     * [上传资源文件](#上传资源文件)
 * [属性](#属性)
@@ -369,6 +370,30 @@
   }
   ```
 
+### 根据路径获取人类可读路径
+
+* `/api/filetree/getHPathByPath`
+* 参数
+
+  ```json
+  {
+    "notebook": "20210831090520-7dvbdv0",
+    "path": "/20210917220500-sz588nq/20210917220056-yxtyl7i.sy"
+  }
+  ```
+
+  * `notebook`：笔记本 ID
+  * `path`：路径
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": "/foo/bar"
+  }
+  ```
+
 ## 资源文件
 
 ### 上传资源文件