Go to file
Adrien Marquès 19d7743b1d update main/mixer | create api common interface 2018-10-22 17:41:49 +02:00
src update main/mixer | create api common interface 2018-10-22 17:41:49 +02:00
.gitignore use npm -> update readme 2018-10-22 17:40:56 +02:00
LICENSE Initial commit 2018-10-17 16:06:39 +02:00
README.md use npm -> update readme 2018-10-22 17:40:56 +02:00
package.json use npm -> update readme 2018-10-22 17:40:56 +02:00
tsconfig.json moved source into 'src' and built into 'dist' | update readme accordingly 2018-10-20 16:14:37 +02:00

README.md

| API mixer |

Simple REST API mixer as a service. A minimal service will be deployed on your local port 8000, all incoming data has to be sent by POST fields (e.g. form-data, x-www-form-urlencoded). The output is a application/json set.

Launch the project

Prerequisites

You need node and npm installed.

1. Install dependencies

Go into the project's folder and run :

$ npm i
2. Transpile sources

Then launch the following command inside the project's folder :

$ npm run build

All source files of the src/ folder will be transpiled into the dist/ folder.

It is also possible to watch the typescript while developping and modifying files with the command npm run watch.

3. Launch server

You need to have node installed.

Launch the server with the following command (inside the project's folder) :

$ node dist/main.js
3. Test the API

Simply use Postman or whatever API client at 127.0.0.1:8000.