Obsidian Stats logoObsidian Stats

API Designer

by Ruveyda Yilmaz
5
4
3
2
1
Score: 53/100
Install Code

Description

Category: Coding & Technical Tools
#api#design#schema#endpoints

The API Designer plugin provides a visual way to craft and document API endpoints directly inside your notes. It lets you define request and response bodies, specify fields with names and data types and adjust these structures quickly as your ideas evolve. The interface stays clean and adapts smoothly to different layouts, which makes it easy to sketch out schemas while writing. Themes can be customised with a simple JSON palette, allowing you to tune the look to your workspace.

Reviews

No reviews yet.

Stats

11
stars
667
downloads
2
forks
241
days
49
days
49
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

1.1.1
2 months ago

Changelog

Replaced image icon with setIcon utility for send button and select icon

See all version on GitHub

README file from

Github

API Designer Plugin

A plugin for Obsidian that lets you design and document API endpoints visually without leaving your notes.

API Designer

Features

  • Create endpoints with request and response bodies
  • Define properties with name and type
  • Add or remove fields instantly
  • Clean, responsive layout that adapts to your workspace

Getting Started

  1. Install and enable the plugin in Obsidian.
  2. Open any note where you want to design an API.
  3. Use the toolbar button to add an endpoint.
  4. Define your request/response fields visually.

Usage Example

That’s it! Your API schema is saved directly in Markdown.

Custom Themes

Personalize your API designer with a custom color scheme:

  1. Open Settings → API Designer.
  2. Add a JSON theme, for example:
{
  "blue": "#4dabf7",
  "green": "#8ed377",
  "yellow": "#fff06eff",
  "red": "#ec687c"
}

If you find this plugin useful, consider supporting me:

ko-fi

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
Media DB Plugin
4 years ago by Moritz Jung
A plugin that can query multiple APIs for movies, series, anime, games, music and wiki articles, and import them into your vault.
Theme Design Utilities
5 years ago by pseudometa
Some utilities and Quality-of-Life features for designers of Obsidian themes.
APIRequest
3 years ago by rooyca
Obsidian plugin that allows you to integrate API data into your notes with request caching, variable support, and precise JSON extraction.
User Plugins
4 years ago by mnowotnik
Allows user scripts to use plugin API
Obsidian to Flomo
4 years ago by Xiaoyu Li
Quickly share content to Flomo.
File Publisher
3 years ago by Devin Sackett
Unofficial Fabric Integration
2 years ago by Chasebank87
Integrate fabric by danielmiessler/fabric into Obsidian
Extended File Support
a year ago by Nick de Bruin
Adds opening and embedding support for various filetypes to Obsidian
Latex Render
2 years ago by jvsteiner
An Obsidian plugin that renders `label` code blocks to `<svg>` for viewing in notes. Make sure to bring your own command!
OpenAPI Renderer
2 years ago by Sentiago
Integrate OpenAPI specification management into Obsidian with features for version control, visualization, editing, and easy navigation of API specs.
Data Fetcher
a year ago by qf3l3k
Fetch data from multiple sources (REST APIs, RPC, gRPC, GraphQL) and insert results into notes.
Magiedit
2 years ago by Matteo Gassend
Browser Note
10 days ago by fengshuzi
Expose a localhost HTTP API (API-key protected) to view, create, edit and delete vault notes, with a built-in browser UI. - This plugin has not been manually reviewed by Obsidian staff.
Sponsors