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
No description
3 commits 3 branches 62 tags 4.6 MiB
TypeScript 94.1%
CSS 3%
JavaScript 2.9%
Find a file
Ronald Cantillo f39c7d1e59
v0.0.1
2023-05-02 21:55:17 -05:00
.editorconfig Initial commit 2023-05-02 20:57:48 -05:00
.eslintignore Initial commit 2023-05-02 20:57:48 -05:00
.eslintrc Initial commit 2023-05-02 20:57:48 -05:00
.gitignore Initial commit 2023-05-02 20:57:48 -05:00
.npmrc Initial commit 2023-05-02 20:57:48 -05:00
esbuild.config.mjs Initial commit 2023-05-02 20:57:48 -05:00
LICENSE v0.0.1 2023-05-02 21:55:17 -05:00
main.ts v0.0.1 2023-05-02 21:49:43 -05:00
manifest.json v0.0.1 2023-05-02 21:49:43 -05:00
package.json v0.0.1 2023-05-02 21:49:43 -05:00
README.md v0.0.1 2023-05-02 21:49:43 -05:00
tsconfig.json Initial commit 2023-05-02 20:57:48 -05:00
version-bump.mjs Initial commit 2023-05-02 20:57:48 -05:00
versions.json Initial commit 2023-05-02 20:57:48 -05:00

README.md

API Request - Obsidian Plugin

The "API Request" is an Obsidian plugin that allows you to make GET requests to APIs and receive responses in the format of a JSON block or an Obsidian variable. We plan to add more request types in the future.

Maunal Installation

  • Copy over main.js and manifest.json to your vault. VaultFolder/.obsidian/plugins/obsidian-api-request/.

Usage

To use the plugin, press Ctrl+P and search for "API Request". The plugin will present you with two options:

  1. Show response in modal
  2. Paste response in current document (at current line)

Select the option that suits your needs. Additionally, you can configure the plugin to output the response in either JSON block format or as an Obsidian variable. This option can be accessed through the plugin's settings.

Settings

The plugin has a few settings that you can configure:

  • URL: The URL to send the request to.
  • Output format: Choose between JSON block or Obsidian variable.

To-do

  • Add more request types (POST, PUT, DELETE, etc.)
  • Add support for authentication
  • Add customizability for modal output (e.g. show only specific fields, change color scheme, add custom CSS)
  • Add customizability for variable output (e.g. show only specific fields, change variable name)
  • Improve error handling and provide meaningful error messages
  • Provide comprehensive documentation and examples for users to reference

Feedback and Contributions

If you encounter any issues or have feedback on the plugin, feel free to open an issue on the GitHub repository. Contributions are also welcome!