Skip to content

Commit 632cd3b

Browse files
committed
docs(README): Add REST methods basic documentation
1 parent ecd647b commit 632cd3b

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,32 @@ npx express-rest-file-server
3333
* storageType: can be `memory` or `disk` (defaults to memory)
3434
* storagePath: where to store the files if storage is set to `disk` (defaults to `/tmp`)
3535

36+
## Routes
37+
38+
### POST /files
39+
40+
Uploads a file to the store with its original name
41+
42+
### POST /files/:filename
43+
44+
Uploads a file to the store with a custom name (:filename)
45+
46+
### POST /files/chunk/:filename
47+
48+
Uploads a chuck of a file to the store with a custom name (:filename)
49+
50+
### POST /files/assemble/:filename
51+
52+
_Builds_ a file from its chunks
53+
54+
### GET /files/:filename
55+
56+
Retrieve a file by its name
57+
58+
### GET /files/:filename/size
59+
60+
Retrieve a file size by its name
61+
62+
### DELETE /files/:filename
63+
64+
Remove a file by its name

0 commit comments

Comments
 (0)