From 05535fd5105d9007160d6f33a83006fc86e9a5f1 Mon Sep 17 00:00:00 2001
From: Michele Cereda <cereda.michele@gmail.com>
Date: Sat, 2 Nov 2024 22:34:53 +0100
Subject: [PATCH] chore(kb): revise docs about api clients

---
 knowledge base/bruno.md               | 70 +++++++++++++++++++++++
 knowledge base/hoppscotch.md          | 81 +++++++++++++++++++++++++++
 knowledge base/hoppscotch.placeholder | 17 ------
 knowledge base/httpie.md              | 70 +++++++++++++++++++++++
 knowledge base/insomnia.md            | 15 +++--
 knowledge base/postman.md             | 30 +++++-----
 6 files changed, 247 insertions(+), 36 deletions(-)
 create mode 100644 knowledge base/bruno.md
 create mode 100644 knowledge base/hoppscotch.md
 delete mode 100644 knowledge base/hoppscotch.placeholder
 create mode 100644 knowledge base/httpie.md

diff --git a/knowledge base/bruno.md b/knowledge base/bruno.md
new file mode 100644
index 0000000..82aa07e
--- /dev/null
+++ b/knowledge base/bruno.md	
@@ -0,0 +1,70 @@
+# Bruno
+
+API client.
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+   1. [Sources](#sources)
+
+## TL;DR
+
+<!-- Uncomment if used
+<details>
+  <summary>Setup</summary>
+
+```sh
+```
+
+</details>
+-->
+
+<!-- Uncomment if used
+<details>
+  <summary>Usage</summary>
+
+```sh
+```
+
+</details>
+-->
+
+<!-- Uncomment if used
+<details>
+  <summary>Real world use cases</summary>
+
+```sh
+```
+
+</details>
+-->
+
+## Further readings
+
+- [Website]
+- [Main repository]
+
+Alternatives:
+
+- [Hoppscotch]
+- [httpie]
+- [Postman]
+
+### Sources
+
+<!--
+  Reference
+  ═╬═Time══
+  -->
+
+<!-- In-article sections -->
+<!-- Knowledge base -->
+[hoppscotch]: hoppscotch.md
+[httpie]: httpie.md
+[postman]: postman.md
+
+<!-- Files -->
+<!-- Upstream -->
+[main repository]: https://github.com/usebruno/bruno
+[website]: https://www.usebruno.com/
+
+<!-- Others -->
diff --git a/knowledge base/hoppscotch.md b/knowledge base/hoppscotch.md
new file mode 100644
index 0000000..9ecd0cb
--- /dev/null
+++ b/knowledge base/hoppscotch.md	
@@ -0,0 +1,81 @@
+# Hoppscotch
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+   1. [Sources](#sources)
+
+## TL;DR
+
+<details>
+  <summary>Setup</summary>
+
+```sh
+brew install --cask 'hoppscotch'
+```
+
+</details>
+
+<!-- Uncomment if used
+<details>
+  <summary>Usage</summary>
+
+```sh
+```
+
+</details>
+-->
+
+<!-- Uncomment if used
+<details>
+  <summary>Real world use cases</summary>
+
+```sh
+```
+
+</details>
+-->
+
+Set environment variables to use with a next request:
+
+```js
+const jsonData = pw.response.body;                // Save the JSON payload response
+pw.env.set("accessToken", jsonData.access_token); // Set "accessToken" to the value of "access_token" in the response
+pw.env.set("idToken", jsonData.id_token);         // Set "idToken" to the value of "id_token" in the response
+```
+
+Access the variables in the request section by referencing the variable in the format `<<variable_name>>`.
+
+post-request scripts == tests.
+
+## Further readings
+
+- [Website]
+- [Main repository]
+- [Documentation]
+
+Alternatives:
+
+- [Bruno]
+- [httpie]
+- [Postman]
+
+### Sources
+
+<!--
+  Reference
+  ═╬═Time══
+  -->
+
+<!-- In-article sections -->
+<!-- Knowledge base -->
+[bruno]: bruno.md
+[httpie]: httpie.md
+[postman]: postman.md
+
+<!-- Files -->
+<!-- Upstream -->
+[documentation]: https://docs.hoppscotch.io/
+[main repository]: https://github.com/hoppscotch/hoppscotch
+[website]: https://hoppscotch.com/
+
+<!-- Others -->
diff --git a/knowledge base/hoppscotch.placeholder b/knowledge base/hoppscotch.placeholder
deleted file mode 100644
index 0f323d6..0000000
--- a/knowledge base/hoppscotch.placeholder	
+++ /dev/null
@@ -1,17 +0,0 @@
-```sh
-brew install --cask 'hoppscotch'
-```
-
-Access the variables in the request section by referencing the variable in the format `<<variable_name>>`.
-
-post-request scripts == tests
-
-Set environment variables to use with a next request:
-
-```js
-const jsonData = pw.response.body;                // Save the JSON payload response
-pw.env.set("accessToken", jsonData.access_token); // Set "accessToken" to the value of "access_token" in the response
-pw.env.set("idToken", jsonData.id_token);         // Set "idToken" to the value of "id_token" in the response
-```
-
-https://docs.hoppscotch.io/
diff --git a/knowledge base/httpie.md b/knowledge base/httpie.md
new file mode 100644
index 0000000..21c4c2f
--- /dev/null
+++ b/knowledge base/httpie.md	
@@ -0,0 +1,70 @@
+# httpie
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+   1. [Sources](#sources)
+
+## TL;DR
+
+<!-- Uncomment if used
+<details>
+  <summary>Setup</summary>
+
+```sh
+```
+
+</details>
+-->
+
+<!-- Uncomment if used
+<details>
+  <summary>Usage</summary>
+
+```sh
+```
+
+</details>
+-->
+
+<!-- Uncomment if used
+<details>
+  <summary>Real world use cases</summary>
+
+```sh
+```
+
+</details>
+-->
+
+## Further readings
+
+- [Website]
+- [Main repository]
+- [Documentation]
+
+Alternatives:
+
+- [Hoppscotch]
+- [Bruno]
+- [Postman]
+
+### Sources
+
+<!--
+  Reference
+  ═╬═Time══
+  -->
+
+<!-- In-article sections -->
+<!-- Knowledge base -->
+[bruno]: bruno.md
+[hoppscotch]: hoppscotch.md
+[postman]: postman.md
+
+<!-- Files -->
+<!-- Upstream -->
+[documentation]: https://httpie.io/docs
+[main repository]: https://github.com/httpie
+[website]: https://httpie.io/
+
+<!-- Others -->
diff --git a/knowledge base/insomnia.md b/knowledge base/insomnia.md
index af710a0..d222ea7 100644
--- a/knowledge base/insomnia.md	
+++ b/knowledge base/insomnia.md	
@@ -26,6 +26,7 @@
 - [Postman], an alternative to Insomnia
 - [Hoppscotch], an alternative to Insomnia
 - [Bruno], an alternative to Insomnia
+- [httpie], an alternative to Insomnia
 
 ## Sources
 
@@ -34,21 +35,23 @@ All the references in the [further readings] section, plus the following:
 - [NPM install module in current directory]
 
 <!--
-  References
+  Reference
+  ═╬═Time══
   -->
 
-<!-- Upstream -->
-[documentation]: https://docs.insomnia.rest/
-[inso cli]: https://docs.insomnia.rest/inso-cli
-[website]: https://insomnia.rest/
-
 <!-- In-article sections -->
 [further readings]: #further-readings
 
 <!-- Knowledge base -->
 [bruno]: bruno.md
 [hoppscotch]: hoppscotch.md
+[httpie]: httpie.md
 [postman]: postman.md
 
+<!-- Upstream -->
+[documentation]: https://docs.insomnia.rest/
+[inso cli]: https://docs.insomnia.rest/inso-cli
+[website]: https://insomnia.rest/
+
 <!-- Others -->
 [npm install module in current directory]: https://stackoverflow.com/questions/14032160/npm-install-module-in-current-directory#45660836
diff --git a/knowledge base/postman.md b/knowledge base/postman.md
index 060ee40..9e0441d 100644
--- a/knowledge base/postman.md	
+++ b/knowledge base/postman.md	
@@ -7,7 +7,7 @@ API platform for building and using APIs.
 1. [TL;DR](#tldr)
 1. [Scripting](#scripting)
 1. [Further readings](#further-readings)
-1. [Sources](#sources)
+   1. [Sources](#sources)
 
 ## TL;DR
 
@@ -67,29 +67,33 @@ More examples [here][scripting in postman].
 - [Website]
 - [Documentation]
 - [Newman], CLI Collection runner for Postman
-- [Insomnia], an alternative to Postman
-- [Hoppscotch], an alternative to Postman
-- [Bruno], an alternative to Postman
 
-## Sources
+Alternatives:
 
-All the references in the [further readings] section, plus the following:
+- [Insomnia]
+- [Hoppscotch]
+- [Bruno]
+- [httpie]
+
+### Sources
 
 - [Scripting in Postman]
 - [Exporting data from Postman]
 
 <!--
-  References
+  Reference
+  ═╬═Time══
   -->
 
+<!-- Knowledge base -->
+[bruno]: bruno.md
+[hoppscotch]: hoppscotch.md
+[httpie]: httpie.md
+[insomnia]: insomnia.md
+[newman]: newman.md
+
 <!-- Upstream -->
 [documentation]: https://learning.postman.com/docs
 [exporting data from postman]: https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/
 [scripting in postman]: https://learning.postman.com/docs/writing-scripts/intro-to-scripts/
 [website]: https://www.postman.com/
-
-<!-- Knowledge base -->
-[bruno]: bruno.md
-[hoppscotch]: hoppscotch.md
-[insomnia]: insomnia.md
-[newman]: newman.md