API Designer

API Designer Plugin

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

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.

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: