docs: 📝 Updated readme.md with some images and installation steps.

This commit is contained in:
Simon Priet 2021-09-08 13:42:19 +02:00
parent e405711220
commit 5fbd7c88fa
3 changed files with 25 additions and 1 deletions

View File

@ -1,2 +1,26 @@
# api-test
# 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.
## Installation and execution
PostMan is required to run them.
1. Download the 3 jsons files
2. Create or select a Workspace that will get them
3. `File` > `Import...` and drag-and-drop them on the lightbox.
![Import modale with some files ready to be imported](./public/import-screen-with-files.jpg)
4. Open the collection properties
![a Collection Properties panel in PostMan](./public/lifen-api-collection-properties.jpg)
5. Run the files with the following settings
* Run the `POST a Json Web Token` is optional, the collection handle the JWT generation and use for each requests
* The servers don't like to be rushed, you will get better results by addind a **Delay** of **500**ms
* You can save the responses to diagnose them after run.
* 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 backed here 😔🍪
![a runner in PostMan](./public/lifen-api-runner.jpg)
## an Example of Test Report in PostMan
![an Example of Test Report](./public/run-result-example.jpg)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB