mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-08 21:34:25 +00:00
chore(kb): revise docs about api clients
This commit is contained in:
Michele Cereda
70
knowledge base/bruno.md
Normal file
70
knowledge base/bruno.md
Normal file
@@ -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 -->
|
||||
81
knowledge base/hoppscotch.md
Normal file
81
knowledge base/hoppscotch.md
Normal file
@@ -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 -->
|
||||
@@ -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/
|
||||
70
knowledge base/httpie.md
Normal file
70
knowledge base/httpie.md
Normal file
@@ -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 -->
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user