bkendall / rest-fs

restful interface to a filesystem.

rest-fs

restful interface to a filesystem

usage

npm install rest-fs

to install

npm start

starts fileserver on port 3000

npm test

runs various file and folder test

npm start

starts server on port 3000 of your entire system

app = require('express')();
restfs = require('rest-fs')
restfs(app);
app.listen(3000)

To use programmatically, pass in the app into restfs and it will add the routes.

API

GET /path/to/dir/

list contents of directory

optional
?recursive = list recursively default false

returns:

[
  {
    "name" : "file1", // name of dir or file
    "path" : "/path/to/file", // path to dir or file 
    "dir" : false // true if directory
  },
  ...
]

GET /path/to/file

returns contents of file
if dir, redirect to dir path

optional
?encoding = default utf8

returns: content of specified file

POST /path/to/file/or/dir

creates or overwrites file
creates dir if it does not exist.
renames or moves file if newPath exists

optional
body.newpath = if exist, move/rename file to this location.
body.clobber = if true will overwrite dest files (default false)
body.mkdirp = if true will create path to new location (default false)
body.mode = permissions of file (defaults: file 438(0666) dir 511(0777))
body.encoding = default utf8

returns: modified resource

{
  "name" : "file1", // name of dir or file
  "path" : "/path/to/file", // path to dir or file 
  "dir" : false // true if directory
}

PUT /path/to/file

creates file

optional
body.mode = permissions of file (438 default 0666 octal)
body.encoding = default utf8

returns: modified resource

{
  "name" : "file1", // name of dir or file
  "path" : "/path/to/file", // path to dir or file 
  "dir" : false // true if directory
}

DEL /path/to/dir/

deletes folder
if file returns error

returns:

{}

DEL /path/to/file

deletes file
if folder returns error

returns:

{}