Description

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.

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

Install and enable the plugin in Obsidian.
Open any note where you want to design an API.
Use the toolbar button to add an endpoint.
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:

Open Settings → API Designer.
Add a JSON theme, for example:

{
  "blue": "#4dabf7",
  "green": "#8ed377",
  "yellow": "#fff06eff",
  "red": "#ec687c"
}

If you find this plugin useful, consider supporting me:

API Designer

Description

Reviews

Stats

Latest Version

Changelog

README file from

API Designer Plugin

Features

Getting Started

Custom Themes

Similar Plugins