https://github.com/coderaiser/node-restafary

REST for CRUD file operations
https://github.com/coderaiser/node-restafary

crud expressjs middleware nodejs rest

Last synced: 6 days ago
JSON representation

REST for CRUD file operations

• Host: GitHub
• URL: https://github.com/coderaiser/node-restafary
• Owner: coderaiser
• License: mit
• Created: 2014-12-08T14:25:16.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-12-20T11:56:46.000Z (about 1 month ago)
• Last Synced: 2025-01-20T03:18:05.162Z (13 days ago)
• Topics: crud, expressjs, middleware, nodejs, rest
• Language: JavaScript
• Size: 405 KB
• Stars: 14
• Watchers: 4
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • License: LICENSE

Awesome Lists containing this project

README

        
# Restafary [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]

**REST** for **CRUD** file operations.

## What is it?

**RE**presentational **S**tate **T**ransfer is an abstraction of the architecture of the World Wide Web.

**C**reate **R**ead **U**pdate **D**elete is 4 basic functions of persistent storage.

## Install

`npm i restafary --save`

## REST

|Name         |Method   |Query          |Body               |Description                    |

|:------------|:--------|:--------------|:------------------|:------------------------------|

|`fs`         |`GET`    |               |                   |get file or dir content        |

|             |         |`sort`         |                   |sort dir content by `name`,    |

|             |         |               |                   |`size` or `time`               |

|             |         |`order`        |                   |order of sorting, can be:      |

|             |         |               |                   |`asc` or `desc`                |

|             |         |`raw`          |                   |get file or raw dir content    |

|             |         |`size`         |                   |get file or dir size           |

|             |         |`raw-size`      |                   |get raw size                   |

|             |         |`hash`         |                   |get file hash                  |

|             |         |`download`     |                   |content disposition attachment |

|             |`PUT`    |               |file content       |create/write file              |

|             |         |`unzip`        |file content       |unzip and create/write file    |

|             |         |`dir`          |                   |create dir                     |

|             |`PATCH`  |               |diff               |patch file                     |

|             |`DELETE` |               |                   |delete file                    |

|             |         |`files`        |Array of names     |delete files                   |

## How to use?

```js

const restafary = require('restafary');

const http = require('node:http');

const express = require('express');

const app = express();

const server = http.createServer(app);

const port = 1337;

const ip = '0.0.0.0';

app.use(restafary({

    prefix: '/fs', // default

    root: '/', // default, can be string or function

}));

app.use(express.static(__dirname));

server.listen(port, ip);

```

## License

MIT

[NPMIMGURL]: https://img.shields.io/npm/v/restafary.svg?style=flat

[BuildStatusURL]: https://github.com/coderaiser/node-restafary/actions?query=workflow%3A%22Node+CI%22 "Build Status"

[BuildStatusIMGURL]: https://github.com/coderaiser/node-restafary/workflows/Node%20CI/badge.svg

[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat

[NPMURL]: https://npmjs.org/package/restafary "npm"

[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"