# API Designer Plugin

A plugin for [Obsidian](https://obsidian.md) that lets you **design and document API endpoints visually** without leaving your notes.

![API Designer](https://github.com/user-attachments/assets/8ba8f2a1-ac79-4bd1-a64e-c12a69ab7ff5)

## 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](https://github.com/user-attachments/assets/412214fa-a414-4e49-aa5c-91479a4510d8)

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:

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

<br />

---

If you find this plugin useful, consider supporting me:

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H5IVCDC)