https://github.com/dtgoitia/postbox

quick, dirty and messy sort of echo-server
https://github.com/dtgoitia/postbox

Last synced: 19 days ago
JSON representation

quick, dirty and messy sort of echo-server

• Host: GitHub
• URL: https://github.com/dtgoitia/postbox
• Owner: dtgoitia
• Created: 2019-09-02T12:24:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T00:47:04.000Z (about 2 years ago)
• Last Synced: 2024-10-28T13:55:22.889Z (2 months ago)
• Language: JavaScript
• Size: 133 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Postbox

_Postbox_ is a simple Node.js server to log incoming HTTP requests.

## Overview

The same way _Postman_ is a tool to **make** requests, _Postbox_ is a tool to **receive** requests (and response back).

**Main use case**

It's difficult to find open free APIs where to make POST, PUT... requests, and inspect/monitor the request details (headers, raw body, etc.). This tool aims to solve this problem by bringing up a local server, which will log in your command line all the received requests.

## Quick start

In your terminal:

1. Navigate to the repo folder.

2. Install: Node.js and NPM required.

    ```

    npm install

    ```

3. Run:

    ```

    npm start

    ```

## Configuration

### Available endpoints

| Route  | Supported methods | Response |

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

| `/`    |  GET, POST, PUT   |   JSON   |

| `/xml` |  GET, POST, PUT   |   XML    |

### Port

The value of the port is specified in `./config.js`.