Lifen/lifen-postman
Lifen/lifen-postman
1
0
Fork 0
Code Pull Requests Releases Activity

docs: 📝 added a TOC in the Readme.md

Browse Source 
I used an extension in VSC, should not produce expected results
This commit is contained in:
Simon Priet 2021-09-08 14:57:48 +02:00
parent 9288d958c6
commit 8a77b8e56d
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,8 +1,20 @@
<!-- vscode-markdown-toc -->
* 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)
<!-- vscode-markdown-toc-config
numbering=true
autoSave=true
/vscode-markdown-toc-config -->
<!-- /vscode-markdown-toc -->
# About lifen-postman # 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`. 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. <a name='InstallationandexecutionviaCLI'></a>Installation and execution via CLI
NodeJs 16+ is required. 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. 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'` 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. <a name='AnexampleofNewManstestreport'></a>An example of NewMan's test report
![An example of NewMan's test report](./public/newman-testresult-example.jpg) ![An example of NewMan's test report](./public/newman-testresult-example.jpg)
## Installation and execution in the PostMan GUI ## 2. <a name='InstallationandexecutioninthePostManGUI'></a>Installation and execution in the PostMan GUI
PostMan is required to run them. 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. * 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 🚫🍪😔 * 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. <a name='anExampleofTestReportinPostMan'></a>an Example of Test Report in PostMan
![an Example of Test Report](./public/run-result-example.jpg) ![an Example of Test Report](./public/run-result-example.jpg)