README.zh-cn.md

一个浏览FTP目录的后端 ✅

这API服务器用于接受主机（host），端口（port)，路径 (path) ，用户名(user)和密码(pass)
连接FTP服务器并发送回目录数据。

🐳 Docker 公共存储库

FTP Seer API服务器也可用作docker映像。 运行此docker命令以使其启动并运行。 必须预先安装Docker CLI。

$ docker pull m3yevn/ftp-seer:latest
$ docker run -d --name ftp-seer -p 5050:5050  m3yevn/ftp-seer:latest

Now, FTP Seer is accessible at 5050 port of your workstation.

📮 请求参数

• 1️⃣ Hostname
• 2️⃣ Port
• 3️⃣ Path
• 4️⃣ Username
• 5️⃣ Password

📧 样品申请

**"\directory?host=sample&port=21&path=sample&username=sample&password=sample"**

**"\file?host=sample&port=21&path=sample/sample.txt&username=sample&password=sample"**

⚡ 试试看这个演示

• 浏览 [这里]
• 这个演示在用着 speedtest.tele2.net

✉️ HTTP方法

方法	路线	描述
GET	“ /”	获得API健康状况
GET	“ /directory	FTP服务器的列表目录
GET	“ /file	在FTP服务器中获取文件内容

📖 技术栈

• NodeJS
• Express 框架
• JS FTP
• JSON

❤️ 为了开始这代码，请使用在下面的命令

$ npm insall
$ node index.js