https://github.com/egeuysall/rest

Post. Expire. Vanish.
https://github.com/egeuysall/rest

api dev docker full-stack json project rest

Last synced: about 1 month ago
JSON representation

Post. Expire. Vanish.

• Host: GitHub
• URL: https://github.com/egeuysall/rest
• Owner: egeuysall
• License: apache-2.0
• Created: 2025-05-23T18:27:11.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-06-02T17:42:55.000Z (about 1 year ago)
• Last Synced: 2025-06-11T08:11:34.395Z (about 1 year ago)
• Topics: api, dev, docker, full-stack, json, project, rest
• Language: TypeScript
• Homepage: https://rest.egeuysal.com
• Size: 24.6 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


  

    

    
Rest


  





    Post. Expire. Vanish.





    

        Contributing

    



## Rest 🛠️

**Rest** is a minimal CLI tool for sharing JSON data via one-time, public REST endpoints.  

Built for developers who need to quickly expose or test JSON payloads **without setup or authentication**.

Perfect for:

- Sharing payloads with teammates

- Testing webhooks or API clients

- Temporary data exposure during development

### 🚀 Installation

Install `rest` using the following one-liner:

```sh

curl -fsSL https://raw.githubusercontent.com/egeuysall/rest/master/install.sh | sh

```

### ⚙️ Usage

```sh

rest -d  [-e ] [-t ]

```

#### Options:

| Flag        | Description                                     | Default |

| ----------- | ----------------------------------------------- | ------- |

| `-d` string | **Required.** Path to your JSON file            | —       |

| `-e` int    | Expiration time in minutes                      | `10`    |

| `-t` int    | Max number of times the payload can be accessed | `1`     |

#### Example

```sh

rest -d ./payload.json -e 10 -t 3

```

This shares `payload.json` for **10 minutes** and allows **up to 3 accesses**.

### 🧹 Auto-Expiration

Payloads are automatically deleted after:

- The expiration time (`-e`) is reached

- They have been accessed `-t` times

### 📦 Use Cases

- Share a JSON response with your frontend team

- Provide sample payloads to test third-party integrations

- Simulate webhooks with disposable endpoints

### 🧑‍💻 Contributing

Contributions are welcome!  

Feel free to open issues or pull requests on [GitHub](https://github.com/egeuysall/rest).

### 📄 License

Licensed under the [Apache License 2.0](./LICENSE).