From f4d46a961b69aa7a34ddb83afd886c1a3752ad39 Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Mon, 19 Nov 2018 14:22:57 +0100 Subject: [PATCH] update readme --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 100995f..768fa8a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Simple REST API mixer as a service. A minimal service will be deployed on your l ##### Prerequisites -You need `node` and `npm` installed. +You need `node` and `npm` installed. The project is written using `typescript` that allows type checking and other verifications before creating the real javascript code. Also it adds polyfills (c.f. babel) to ECMAScript that allows the use of `class` and other new ES features. ##### 1. Install dependencies @@ -18,7 +18,7 @@ $ npm i ##### 2. Transpile sources -Then launch the following command inside the project's folder : +Run the following command inside the project's folder : ```bash $ npm run build ``` @@ -46,4 +46,12 @@ $ npm start; ### Test the API -You can now use [Postman](https://www.getpostman.com/) or whatever API client at `127.0.0.1:8000`. +You can now use [Postman](https://www.getpostman.com/) or whatever API client or web browser at `127.0.0.1:8000`. The only allowed request method is **GET** and accepts the research field in a query parameter named 'q'. + + + +Example URL : http://127.0.0.1:8080?q=Nutella that searches for the keyword "Nutella". + +> When called in a browser you will get a simple web page that is the representation of the results (with images). +> +> When called with the header `Accept: application/json`, the result will represent the data as a JSON object. \ No newline at end of file