Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shepf authored Nov 25, 2023
1 parent 4c3b3fc commit 26d7ebf
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ vi ./conf/svr.yml

linux下运行:
```bash
./httpcat -c conf/svr.yml
./httpcat -C conf/svr.yml
```

windows下运行:
Expand All @@ -52,7 +52,7 @@ Create a new tmux session using a socket file named tmux_httpcat
$ tmux -S tmux_httpcat

# 进入tmux后,可以执行运行命令,如:
httpcat --static=/home/web/website/upload/ --c server/conf/svr.yml
httpcat --static=/home/web/website/upload/ -C server/conf/svr.yml

Move process to background by detaching
Ctrl+b d OR ⌘+b d (Mac)
Expand Down Expand Up @@ -83,7 +83,8 @@ ExecStart=/usr/local/bin/httpcat --static=/home/web/website/upload/ --upload=/


## ❤使用技巧
### 使用curl工具上传文件
### 文件操作相关接口
#### 使用curl工具上传文件
```bash
curl -vF "f1=@/root/hello.mojo" http://localhost:8888/api/v1/file/upload
```
Expand All @@ -96,8 +97,8 @@ curl -vF "f1=@/root/hello.mojo" http://localhost:8888/api/v1/file/upload
> 注意: f1 为服务端代码定义的,修改为其他,如file,会报错上传失败。

### 下载文件
#### api 接口
#### 下载文件
##### api 接口
查看下载根目录下,某个目录的文件列表
`http://127.0.0.1:8888/api/v1/file/listFiles?dir=
`
Expand All @@ -108,6 +109,17 @@ curl -vF "f1=@/root/hello.mojo" http://localhost:8888/api/v1/file/upload
`http://{{ip}}:{{port}}/api/v1/file/fileInfo?name=FlF9mrjXgAAZHon.jpg
`

### p2p相关接口
需要配置文件开启p2p功能,默认关闭

#### 通过http接口向p2p网络发送消息
http://{{ip}}:{{port}}/api/v1/p2p/send_message
POST
{
"topic": "httpcat",
"message": "ceshi cccccccccccc"
}

## 💪TODO
1. 接口增加签名认证机制
将请求方法、URL、查询字符串、访问密钥、时间戳、请求体的哈希值等信息按照一定规则拼接起来,并使用给定的密钥进行签名计算。
Expand Down

0 comments on commit 26d7ebf

Please sign in to comment.