obsidian-plugin/rooyca_obsidian-api-request
1
0
Fork 0
mirror of https://github.com/rooyca/obsidian-api-request.git synced 2026-07-22 07:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update(docs): add doc badge

Browse source
This commit is contained in:
Ronald Cantillo 2024-05-09 14:17:20 -05:00 committed by GitHub
parent 905f187948
commit 7169ae1945
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,16 +1,18 @@
# APIR - API Request
Obsidian plugin that allows you to make requests to API's and receive responses in code-blocks or store them in `localStorage`.
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rooyca/obsidian-api-request?logo=github&color=ee8449&style=flat-square)](https://github.com/rooyca/obsidian-api-request/releases/latest)
[![Obsidian plugin release](https://img.shields.io/badge/Obsidian%20plugin%20release-purple?logo=obsidian&style=flat-square)](https://obsidian.md/plugins?id=api-request)
[![Docs site](https://img.shields.io/badge/docs-GitHub_Pages-blue)](https://rooyca.github.io/obsidian-api-request/)
![req_img](req-codeblock.gif)
Obsidian plugin that allows you to make requests to API's and receive responses in code-blocks or store them in `localStorage`.
> [!IMPORTANT]
>
> JSON, TEXT, HTML and MARKDOWN responses supported
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rooyca/obsidian-api-request?logo=github&color=ee8449&style=flat-square)](https://github.com/rooyca/obsidian-api-request/releases/latest)
[![Obsidian plugin release](https://img.shields.io/badge/Obsidian%20plugin%20release-purple?logo=obsidian&style=flat-square)](https://obsidian.md/plugins?id=api-request)
![req_img](req-codeblock.gif)
## Installation
The plugin can be installed from within Obsidian.
@ -29,8 +31,7 @@ There are two ways to use the plugin:
### With Code-blocks
To use it, create a code-block with the language set to `req`. Inside the code-block, you can specify `url`, `method`, `body`, `headers`, `format`, etc. For more information check [documentation](https://rooyca.github.io/obsidian-api-request).
To use it, create a code-block with the language set to `req`. Inside the code-block, you can specify `url`, `method`, `body`, `headers`, `format`, etc.
```req
url: https://api.chess.com/pub/player/hikaru/stats
@ -129,4 +130,4 @@ The plugin has a few settings that you can configure:
## Feedback and Contributions
If you encounter any issues or have feedback on the plugin, feel free to open an issue on the [GitHub repository](https://github.com/Rooyca/obsidian-api-request). Contributions are also welcome!
If you encounter any issues or have feedback on the plugin, feel free to open an issue on the [GitHub repository](https://github.com/Rooyca/obsidian-api-request). Contributions are also welcome!