zmyme/HTTPImageServer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update

Browse Source
This commit is contained in:
mingyang 2021-01-27 16:18:47 +08:00
parent a2f6a5e94e
commit ee12687abb
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -30,14 +30,15 @@ The server.py mainly provides two api.
/directory?path=relative/path/to/file /directory?path=relative/path/to/file
``` ```
params: params:
path: the directory that you want to list. - path: the directory that you want to list.
return: return:
```json
{ ```json
{
"dirs": [list, of, subdirs], "dirs": [list, of, subdirs],
"imgs": [image, file, under, the, directory], "imgs": [image, file, under, the, directory],
} }
``` ```
2. to access the image: 2. to access the image:
``` ```
@ -45,17 +46,17 @@ return:
``` ```
params: params:
- path: the image that you want to access. - path: the image that you want to access.
- height: image max height. - height: image max height.
- width: image max width. - width: image max width.
> Note: if no height and width are provided, the original image will be returned. > Note: if no height and width are provided, the original image will be returned.
return: return:
the image stream. - the image stream.
For more details about the structure, please see the network.py. For more details about the structure, please see the network.py.