api-mixer/README.md

1.2 KiB

| 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.

Project Set up

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

Project fast start

This command will build and run the whole project :

$ npm run build;
$ npm start;

Test the API

You can now use Postman or whatever API client at 127.0.0.1:8000.