Merge pull request #52 from jkone27/add-mermaid-to-docs

Add mermaid to docs

Author: jkone27

README.md

@@ -13,6 +13,23 @@ This library makes use of [F# computation expressions](https://learn.microsoft.c
 
 A C# API is also available, access the [documentation](https://jkone27.github.io/fsharp-integration-tests/) website for more info on how to use this library.  
 
+## Scenario
+
+```mermaid
+sequenceDiagram
+    participant TestClient as Test
+    participant MainApp as App
+    participant DependencyApp as Dep
+
+    TestClient->>MainApp: GET /Hello
+    MainApp->>DependencyApp: GET /externalApi
+    DependencyApp-->>MainApp: Response
+    MainApp-->>TestClient: Response
+
+```
+
+## Test
+
 ```fsharp
 open ApiStub.FSharp.CE
 open ApiStub.FSharp.BuilderExtensions

docs/index.md

@@ -25,6 +25,22 @@ To use the CE, you must build your CE object first by passing the generic `Progr
 Suppose in your main app (`Program` or `Startup`) you call `Services.AddApiClient`(or its variants) twice, registering 2 API clients to make calls to other services, say to the outbound routes `/externalApi` and `/anotherApi` (let's skip the base address for now).
 suppose `ExternalApiClient` invokes an http `GET` method and the other client makes a `POST` http call, inside your API client code. 
 
+```mermaid
+sequenceDiagram
+    participant TestClient as Test
+    participant MainApp as App
+    participant DependencyApp1 as ApiDep1 
+    participant DependencyApp2 as ApiDep2
+
+    TestClient->>MainApp: GET /Hello
+    MainApp->>DependencyApp1: GET /externalApi
+    DependencyApp1-->>MainApp: Response
+    MainApp->>DependencyApp2: POST /anotherApi
+    DependencyApp2-->>MainApp: Response
+    MainApp-->>TestClient: Response
+
+```
+
 ### HTTP Mocks 🤡
 
 It's easy to **mock** those http clients dependencies (with data stubs) during integration tests making use of `ApiStub.FSharp` lib, saving quite some code compared to manually implementing the `WebApplicationFactory<T>` pattern, let's see how below.