Skip to content

A rest API for remotely manipulating a filesystem.

Notifications You must be signed in to change notification settings

cpowicki/fs-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fs-api

A rest API for remotely manipulating a filesystem.

Getting Started

You can run fs-api with the included run.sh script.

bash scripts/run.sh

You can also use make to:

  • linux compiles for linux
  • darwin compiles for darwin
  • dockerize builds a local docker image
  • clean clear local builds
  • test runs unit tests

To run the containerized app:

make dockerize
docker run -p 3030:3030 fs-api:latest [<ARGS>]

CLI

./fsapi -h

Usage of ./fs-api:
  -port int
        the server port (default 3030)
  -root string
        the root directory to expose for browsing (default "$HOME")

HTTP API

GET /

Returns a listing of the metadata of objects in the configured root directory

GET /:path

Returns either:

  • The file contents as string, if path is a file
  • A listing of metadata objects if path is a directory

About

A rest API for remotely manipulating a filesystem.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published