docs: add API document

Author: marjune163

doc/en-US/api.md

@@ -0,0 +1,80 @@
+# Render page of specified path
+```
+GET <path>
+```
+Should work no matter tailing “/” is present or not in path.
+
+Example:
+```sh
+curl http://localhost/ghfs/
+```
+
+# Get JSON data of specified path
+```
+GET <path>?json
+```
+
+Example:
+```sh
+curl http://localhost/ghfs/?json
+```
+
+# Get contents of specified path as archive file
+Only work when "archive" is enabled.
+```
+GET <path>?tar
+GET <path>?tgz
+GET <path>?zip
+```
+
+Example:
+```sh
+curl http://localhost/tmp/?zip > tmp.zip
+```
+
+# Upload files to specific path
+Only work when "upload" is enabled.
+```
+POST <path>?upload[&json]
+```
+- Must use `POST` method
+- Must use `multipart/form-data` encoding type
+- Each file content use one part, field name is `file`
+
+Example:
+```sh
+curl -F '[email protected]' -F '[email protected]' http://localhost/tmp/?upload
+```
+
+# Create directories in specific path
+Only work when "mkdir" is enabled.
+```
+GET <path>?mkdir[&json]&name=<dir1>&name=<dir2>&...name=<dirN>
+```
+```
+POST <path>?mkdir[&json]
+
+name=<dir1>&name=<dir2>&...name=<dirN>
+```
+
+Example:
+```sh
+curl -X POST -d 'name=dir1&name=dir2&name=dir3' http://localhost/tmp/?mkdir
+```
+
+# Delete files or directories in specific path
+Only work when "delete" is enabled.
+Directories will be deleted recursively.
+```
+GET <path>?delete[&json]&name=<dir1>&name=<dir2>&...name=<dirN>
+```
+```
+POST <path>?delete[&json]
+
+name=<dir1>&name=<dir2>&...name=<dirN>
+```
+
+Example:
+```sh
+curl -X POST -d 'name=dir1&name=dir2&name=dir3' http://localhost/tmp/?delete
+```

doc/zh-CN/api.md

@@ -0,0 +1,80 @@
+# 为指定路径显示页面
+```
+GET <path>
+```
+无论路径是否以“/”结尾，都应正常工作。
+
+举例：
+```sh
+curl http://localhost/ghfs/
+```
+
+# 获取指定路径JSON形式的数据
+```
+GET <path>?json
+```
+
+举例：
+```sh
+curl http://localhost/ghfs/?json
+```
+
+# 以打包文件形式获取指定路径下的内容
+仅在“archive”选项启用时有效。
+```
+GET <path>?tar
+GET <path>?tgz
+GET <path>?zip
+```
+
+举例：
+```sh
+curl http://localhost/tmp/?zip > tmp.zip
+```
+
+# 上传文件到指定路径
+仅在“upload”选项启用时有效。
+```
+POST <path>?upload[&json]
+```
+- 必须使用`POST`方法
+- 必须使用`multipart/form-data`编码
+- 每个文件内容占用一个段，字段名为`file`
+
+举例：
+```sh
+curl -F '[email protected]' -F '[email protected]' http://localhost/tmp/?upload
+```
+
+# 在指定路径下创建目录
+仅在“mkdir”选项启用时有效。
+```
+GET <path>?mkdir[&json]&name=<dir1>&name=<dir2>&...name=<dirN>
+```
+```
+POST <path>?mkdir[&json]
+
+name=<dir1>&name=<dir2>&...name=<dirN>
+```
+
+举例：
+```sh
+curl -X POST -d 'name=dir1&name=dir2&name=dir3' http://localhost/tmp/?mkdir
+```
+
+# 在指定路径下删除文件或目录
+仅在“delete”选项启用时有效。
+目录将被递归删除。
+```
+GET <path>?delete[&json]&name=<dir1>&name=<dir2>&...name=<dirN>
+```
+```
+POST <path>?delete[&json]
+
+name=<dir1>&name=<dir2>&...name=<dirN>
+```
+
+举例：
+```sh
+curl -X POST -d 'name=dir1&name=dir2&name=dir3' http://localhost/tmp/?delete
+```