docs(linted docs and updated routes in examples): linted docs and updated routes in examples

Author: flo

README.md

@@ -1,56 +1,63 @@
 # JSON Serverless [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![Build Status](https://travis-ci.org/pharindoko/json-serverless.svg?branch=master)](https://travis-ci.org/pharindoko/json-serverless) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) <a href="https://codeclimate.com/github/pharindoko/json-serverless/maintainability"><img src="https://api.codeclimate.com/v1/badges/12f2aa333ec4e24b1ac9/maintainability" /></a>
 
-  - [Features](#features)
-  - [Quickstart](#quickstart)
-  - [Customization](#customization)
-  - [Used Packages](#used-packages)
-  - [Components](#components)
-  - [Develop locally](#develop-locally)
-  - [Develop locally with cloud resources](#develop-locally-with-cloud-resources)
-  - [Diagnose issues](#diagnose-issues)
+- [Features](#features)
+- [Quickstart](#quickstart)
+- [Customization](#customization)
+- [Used Packages](#used-packages)
+- [Components](#components)
+- [Develop locally](#develop-locally)
+- [Develop locally with cloud resources](#develop-locally-with-cloud-resources)
+- [Diagnose issues](#diagnose-issues)
 
 ## Features
+
 - Development: 
    - Easily setup routes and resources for the REST Api via json file. [(via json-server)](https://github.com/typicode/json-server)
    - This solution written in **NodeJS** can be easily extended for additional enhanced scenarios
-      * adding user authentication
-      * own custom domain
-      * additional routes etc.
+      - adding user authentication
+      - own custom domain
+      - additional routes etc.
    - Develop and test solution locally in Visual Studio Code
 - Security: This Api is secured via API Key and https by default.
-- Deployment: 
+- Deployment:
    - Deployed in AWS cloud within Minutes by a single command
    - Almost **zero costs** (First million requests for Lambda are free)
    - Less maintenance as the deployed solution runs **serverless**
 
 ## Quickstart
+
 ##### 1. Clone Solution
+
 ```bash
 git clone https://github.com/pharindoko/json-serverless.git 
 cd json-serverless
 ```
 
 ##### 2. Install dependencies
+
 ```bash
 npm install -g serverless
 npm i
 ```
 
 ##### 3. Verify AWS Access / Credentials
+
 => You need to have access to AWS to upload the solution.
+
 ```bash
 aws sts get-caller-identity
 ```
+
 ##### 4. Update db.json file in root directory
 
 - Childproperties are the REST endpoints you create
-- Samplefile: Routes marked <b>bold</b>
+- Samplefile: Routes marked **bold**
 
 <pre><code>
 {
-    "<b>basic</b>": {
-        "hello": "world"
-    }
+    "<b>posts</b>": [
+      { "id": 1, "title": "json-server", "author": "typicode" }
+    ]
 }
 </code></pre>
 
@@ -65,7 +72,8 @@ serverless deploy --stage dev
 - serverless-webpack is used
 - the build will be triggered automatically
 
-##### 6. When the deployment with serverless framework was successful you can see following output:
+##### 6. When the deployment with serverless framework was successful you can see following output
+
 <pre>
 <code>
 Service Information
@@ -86,55 +94,64 @@ Serverless: Removing old service artifacts from S3...
 </pre></code>
 
 ##### 7. Test your Api
-##### With Curl:
+
+##### With Curl
 
 1. replace the url with the url provided by serverless (see above)
 2. replace the {API - KEY} with the key you get from serverless (see above)
-3. replace {route} at the end of the url e.g. with basic (default value)
+3. replace {route} at the end of the url e.g. with posts (default value)
 
+Default Schema:
 
-```
-Basic Schema:
-curl -H "x-api-key: {API - KEY}" -H "Content-Type: application/json" https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/{route}
-
+```bash
+Default route is posts: (see db.json)
+curl -H "x-api-key: {API - KEY}" -H "Content-Type: application/json" https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/posts 
 
-Default route is basic: (see db.json)
-curl -H "x-api-key: {API - KEY}" -H "Content-Type: application/json" https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/basic 
+#or another route given in db.json file
+curl -H "x-api-key: {API - KEY}" -H "Content-Type: application/json" https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/{route}
 ```
-##### With Postman:
 
-* Create a new GET Request and add these values to the header section
+##### With Postman
+
+- Create a new GET Request and add these values to the header section
 
    |Key|           Value|
    |---|---|
    |x-api-key | {API - KEY}|
    |Content-Type | application/json|
 
- * Enter as Url the endpoints url 
+- Enter as Url the endpoints url
 
-```bash 
+```bash
     https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/{route} 
-    # e.g. default value: https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/basic
+    # e.g. default value: https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/posts
 ```
-What`s my {route} ? -> see [json-server documentation](https://github.com/typicode/json-server)
-
 
+What`s my {route} ? -> see [json-server documentation](https://github.com/typicode/json-server)
 
 ## Customization
 
 #### Update content of db.json
+
 1. update local db.json file in root directory with new values
 2. re-deploy the stack via serverless framework
+
    ```bash
     sls deploy
    ```
+
 3. delete db.json file in S3 Bucket
+4. Make a GET request against the root url https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev/
+
+```bash
+curl -H "x-api-key: {API - KEY}" -H "Content-Type: application/json" https://xxxxxx.execute-api.eu-central-1.amazonaws.com/dev
+```
 
 => With the next request a new db.json file will be created in the S3 Bucket
 
 #### Change Stackname
-[edit service property in serverless.yml (in root directory)](https://github.com/pharindoko/json-server-less-lambda/blob/66756961d960c44cf317ca307b097f595799a890/serverless.yml#L8)
 
+[edit service property in serverless.yml (in root directory)](https://github.com/pharindoko/json-server-less-lambda/blob/66756961d960c44cf317ca307b097f595799a890/serverless.yml#L8)
 
 #### Adapt settings in config/servleressconfig.yml file
 
@@ -144,61 +161,59 @@ What`s my {route} ? -> see [json-server documentation](https://github.com/typico
 | S3BUCKET  | S3-Bucket - this bucket must already exist in AWS  | string | json-server-less-lambda-dev |
 | READONLY  | all API - write operations are forbidden (http 403))  | boolean | false |
 
-
-
 ## Used Packages
-* [json-server](https://github.com/typicode/json-server)
-* [serverless framework](https://serverless.com/)
-* [serverless http](https://github.com/dougmoscrop/serverless-http)
-* [lowdb-adapter-aws-s3](https://github.com/nicekiwi/lowdb-adapter-aws-s3)
 
+- [json-server](https://github.com/typicode/json-server)
+- [serverless framework](https://serverless.com/)
+- [serverless http](https://github.com/dougmoscrop/serverless-http)
+- [lowdb-adapter-aws-s3](https://github.com/nicekiwi/lowdb-adapter-aws-s3)
 
 ## Components
-* [NodeJS 8.10](https://nodejs.org/en/about/) 
-* [AWS API Gateway](https://aws.amazon.com/api-gateway/)
-* [AWS Lambda](https://aws.amazon.com/lambda/features/)
-* [AWS S3](https://aws.amazon.com/s3/)
+
+- [NodeJS 8.10](https://nodejs.org/en/about/) 
+- [AWS API Gateway](https://aws.amazon.com/api-gateway/)
+- [AWS Lambda](https://aws.amazon.com/lambda/features/)
+- [AWS S3](https://aws.amazon.com/s3/)
 
 ## Develop locally
+
 db.json file will be loaded directly from your local filesystem. No AWS access is needed.
 
 #### 1. Start solution
-```
+
+```bash
 npm run start
 ```
 
 #### 2. Test your API
 
 To test you can use e.g. [Postman](https://www.getpostman.com/)
 
-
-* Open Postman
-* Enter as Url the endpoints url 
+- Open Postman
+- Enter as Url the endpoints url 
 
 ```bash
-    https://localhost:3000/{route} #e.g. default value: https://localhost:3000/basic 
+    https://localhost:3000/{route} #e.g. default value: https://localhost:3000/posts/ 
 ```
 
-
 What`s my {route} ? -> see [json-server documentation](https://github.com/typicode/json-server)
 
-
-
 ## Develop locally with cloud resources
+
 Use same componentes (S3, LowDB) as the lambda does but have code executed locally.
 
 #### 1. Add .env file to root folder
 
-
 **Mind:** If you haven`t deployed the solution yet, please create a private S3-Bucket and .json - file manually or deploy the solution first to AWS via serverless framework<br>
 **Mind:** This function requires that you have access to AWS (e.g. via credentials)
 
-* Copy the .env file from .env.sample in the root folder
-```
+- Copy the .env file from .env.sample in the root folder
+
+```bash
 cp .env.sample .env
 ```
 
-* Required: Adapt settings in .env file
+- Required: Adapt settings in .env file
 
 | Attribute  | Description  | Type | Default |
 |---|---|---|---|
@@ -216,26 +231,22 @@ npm run dev
 
 To test you can use e.g. [Postman](https://www.getpostman.com/)
 
-
-* Open Postman
-* Enter as Url the endpoints url 
+- Open Postman
+- Enter as Url the endpoints url
 
 ```bash
-    https://localhost:3000/{route} #e.g. default value: https://localhost:3000/basic 
+    https://localhost:3000/{route} #e.g. default value: https://localhost:3000/posts 
 ```
 
-
 What`s my {route} ? -> see [json-server documentation](https://github.com/typicode/json-server)
 
+## Diagnose issues
 
-## Diagnose issues 
 serverless-offline will help you to troubleshoot issues with the lambda execution in a fast manner.
 
 **Mind:** The assumption is that the solution has been already deployed<br>
 **Mind:** This function requires that you have access to AWS (e.g. via credentials)
 
-
-
 #### 1. build sources and execute serverless offline
 
 - sources will be build with babel in advance to test the functionality.
@@ -254,9 +265,9 @@ Serverless: Remember to use <b>x-api-key</b> on the request headers
 #### 2. make api calls
 
 - Use a new terminal window and start to make api calls.
-- Replace {API-KEY} with the api key in the sls offline output (see above). 
-- Replace {route} with the route you want to test e.g. /basic
+- Replace {API-KEY} with the api key in the sls offline output (see above).
+- Replace {route} with the route you want to test e.g. /posts
 
 <pre><code>
 curl -H "x-api-key: {API-KEY}" -H "Content-Type: application/json" http://localhost:3000/{route}
-</pre></code>
+</pre></code>