From 8a77b8e56d7886fa2081f95e539b355107f89491 Mon Sep 17 00:00:00 2001 From: Simon Priet Date: Wed, 8 Sep 2021 14:57:48 +0200 Subject: [PATCH] docs: :memo: added a TOC in the Readme.md I used an extension in VSC, should not produce expected results --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fbca31e..cdc698d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ + +* 1. [Installation and execution via CLI](#InstallationandexecutionviaCLI) + * 1.1. [An example of NewMan's test report](#AnexampleofNewManstestreport) +* 2. [Installation and execution in the PostMan GUI](#InstallationandexecutioninthePostManGUI) + * 2.1. [an Example of Test Report in PostMan](#anExampleofTestReportinPostMan) + + + + # About lifen-postman This repository holds some PostMan files that performs tests against Lifen's Fhir API. They represent my handout regardinf the technical test. There is also a Node programm that run `NewMan`. -## Installation and execution via CLI +## 1. Installation and execution via CLI NodeJs 16+ is required. @@ -12,11 +24,11 @@ NodeJs 16+ is required. 3. Install `NewMan` via npm with the command `npm install`. It will lookup eveything based on the `package.json` file. 4. Run newman via the npx command `npx newman run .\lifen-api.postman_collection.json -e '.\fhir-api public post-prod.postman_environment.json'` -### An example of NewMan's test report +### 1.1. An example of NewMan's test report ![An example of NewMan's test report](./public/newman-testresult-example.jpg) -## Installation and execution in the PostMan GUI +## 2. Installation and execution in the PostMan GUI PostMan is required to run them. @@ -34,7 +46,7 @@ PostMan is required to run them. * The request `GET CommunicationRequest` wait 10 sec before being launched, because Irène may not have processed the CommunicationRequest that early. * There is no need to save the cookies, as there will be no cookies baked here 🚫🍪😔 -### an Example of Test Report in PostMan +### 2.1. an Example of Test Report in PostMan ![an Example of Test Report](./public/run-result-example.jpg)