mirror of
https://github.com/rooyca/obsidian-api-request.git
synced 2026-07-22 07:50:27 +00:00
update(docs): improve readability
This commit is contained in:
parent
89109479c2
commit
906702d71e
6 changed files with 37 additions and 17 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# Usecase
|
||||
# Usecases
|
||||
|
||||
A collection of use cases for this plugin. **If you have a one, please share it with us.**
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,31 @@
|
|||
# 🚀 APIRequest
|
||||
# 🔎 Overview
|
||||
|
||||
[](https://obsidian.md/plugins?id=api-request)
|
||||
[](https://github.com/rooyca/obsidian-api-request/releases/latest)
|
||||
<img alt="GitHub Release" src="https://img.shields.io/github/downloads/rooyca/obsidian-api-request/total?logo=github&&color=ee8449&style=flat-square">
|
||||
APIRequest (APIR) is a plugin for the note taking app [Obsidian](https://obsidian.md/) that allows you to make requests to apis display the response in your notes.
|
||||
|
||||
> [](es/index.md)
|
||||
> [](en/index.md)
|
||||
> [](zh/index.md)
|
||||
## 🔥 Features
|
||||
|
||||
- Perform requests using various methods such as `GET`, `POST`, `PUT`, and `DELETE`.
|
||||
- Use variables from the `front-matter`, global variables or even reuse responses from another codeblocks.
|
||||
- Save responses in the `localStorage` for convenient access and reuse.
|
||||
- Disable code blocks as needed to optimize performance.
|
||||
- Extract and display specific values from responses, giving you fine-grained control over how data is presented.
|
||||
|
||||
## ⚡ How to use
|
||||
|
||||
To make a request, create a code-block with the language set to `req`. Inside the code-block, you can define parameters such as `url`, `method`, `body`, `headers`, etc. See the [available flags](en/codeblocks#flags) for a complete reference.
|
||||
|
||||
~~~markdown
|
||||
```req
|
||||
url: https://my-json-server.typicode.com/typicode/demo/comments
|
||||
method: post
|
||||
body: {"id":1}
|
||||
headers: {"Accept": "application/json"}
|
||||
show: $.id
|
||||
req-uuid: IDpersona
|
||||
disabled
|
||||
```
|
||||
~~~
|
||||
|
||||
## 🧩 Use Cases
|
||||
|
||||
Check out the [Use Cases](en/usecase) section for examples of how you can use APIRequest in your workflows.
|
||||
|
|
|
|||
|
|
@ -23,15 +23,13 @@ theme:
|
|||
|
||||
nav:
|
||||
- English:
|
||||
- Overview: en/index.md
|
||||
- Usage:
|
||||
- codeblocks: en/codeblocks.md
|
||||
- usecase: en/usecase
|
||||
- Usage: en/codeblocks.md
|
||||
- Use Cases: en/usecase
|
||||
- Español:
|
||||
- Inicio: es/index.md
|
||||
- Uso:
|
||||
- bloques de código: es/codeblocks.md
|
||||
- ejemplos de uso: es/usecase
|
||||
- Cómo usar: es/codeblocks.md
|
||||
- Casos de uso: es/usecase
|
||||
- 中文:
|
||||
- 概述: zh/index.md
|
||||
- 用法:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"id": "api-request",
|
||||
"name": "APIRequest",
|
||||
"version": "2.0.5",
|
||||
"version": "2.0.6",
|
||||
"minAppVersion": "0.15.0",
|
||||
"description": "Fetch data from APIs or other sources. Responses in JSON, MD or HTML directly in your notes.",
|
||||
"author": "rooyca",
|
||||
|
|
|
|||
2
package-lock.json
generated
2
package-lock.json
generated
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "api-request",
|
||||
"version": "2.0.5",
|
||||
"version": "2.0.6",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "api-request",
|
||||
"version": "2.0.5",
|
||||
"version": "2.0.6",
|
||||
"description": "Fetch data from APIs or other sources. Responses in JSON, MD or HTML directly in your notes.",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
|
|
|
|||
Loading…
Reference in a new issue