Local API Reference reads endpoint details from your vault

Name: Local API Reference
Author: theluckystrike

Inspect endpoints and schema properties in local OpenAPI files.

Install in Obsidian

Directory page Source on GitHub

MIT · no telemetry · core features free

A POST pets endpoint with content types, response codes and a schema button. — Open larger

version: 1.1.0
released: 2026-10-21
downloads: 25
review: Passed
health: Excellent
license: MIT
listed for: Desktop, Mobile
obsidian: 1.13.4 or later

Phone and tablet use, live GitHub sign-in and paid sponsorship were not tested in this build.

Directory facts fetched 2026-10-23 07:28 UTC from community.obsidian.md/users/theluckystrike.

About Local API Reference

You keep API specifications beside your notes and need to read endpoint details without calling the service.

Local API Reference reads a JSON or YAML OpenAPI file from your vault. Choose an endpoint to inspect its parameters and responses. The reader leaves the specification unchanged and does not call its API.

Select local API endpoints and open a schema

Free features

Select a file from the vault

Choose a JSON, YAML or YML file from the vault picker. Files have a 5 MiB limit. The source path stays visible above the endpoint list.

Read endpoints by tag

Browse methods, paths and summaries grouped by operation tag. Endpoints with two tags appear in both sections; untagged endpoints appear under Untagged. The free tag selection lasts while the view stays open.

Check parameters and responses

Read parameter names, locations, types and required states, plus request content types and response codes. Operation parameters replace matching path parameters. Descriptions display as plain text.

Open local schema references

Open one level of schema properties and follow internal JSON Pointer references in the same document. Self references remain links. Missing targets, cycles and external references show messages instead of expanding.

Reading and temporary tag filtering are free; endpoint notes, bookmarks and saved tag filters need Pro.

Pro features

Pro costs $5 a month or $15 one time through GitHub Sponsors. One sponsorship turns on Pro in every plugin that has it.

Write endpoint notes Pro

Create a Markdown snapshot of the selected endpoint at the vault root. The note includes the source path, parameters, request content types and response codes. Numbered names avoid existing notes.

Save bookmarks and tag filters Pro

Save endpoint bookmarks tied to a source path and endpoint ID. Save named tag filters for later use. Saved choices remain in plugin data when Pro turns off, while their controls disappear.

See how Pro works

Set up Local API Reference

needs

Obsidian 1.13.4 or later

steps

Put an OpenAPI 3.0 or 3.1 JSON or YAML file in your vault.
Run Open local API file from the command palette.
Select the file, then choose an endpoint in the tag list.
Read its details and open a schema button to inspect properties.
After editing the source elsewhere, select Reload source.

If the app can't find a new plugin yet, try again later. Obsidian says a plugin that passes the review shows in the app within 24 hours.

How to read OpenAPI files in Obsidian

Known limits of Local API Reference

The reader accepts OpenAPI 3.0 and 3.1 files up to 5 MiB; Swagger 2.0 needs conversion first.
External file and remote references are unsupported and are not fetched.
Schema views show one level of properties and do not merge schema composition.
This reader does not validate complete OpenAPI rules or execute API requests.
Select Reload source after an edit; exported notes do not update with the specification.
Bookmarks keep the old source path after a rename.
Phone, tablet, Linux and Windows devices, screen readers and live GitHub sign-in were not tested.

Questions about Local API Reference

Can I try an API request here?

The reader has no request runner or URL importer. Put the specification in your vault first; external references are not fetched.

Does it validate the complete specification?

It checks the version and parses supported endpoint fields. Complete OpenAPI validation, schema composition, callbacks, webhooks and security views are outside this version.

Will bookmarks follow a renamed file?

Bookmarks keep the original source path. Reopen a renamed specification from the picker; exported endpoint notes remain independent snapshots.

Does the view refresh when I edit the source?

Source edits do not refresh the view automatically. Select Reload source after making changes in your editor.

Network use

After you choose Sign in with GitHub, github.com receives the public client ID, profile scope and device-flow polling requests. After sign-in, api.github.com receives an authenticated query for your sponsorship tier and total payment; neither host receives vault data. Successful checks last seven days; network failures can retry after six hours, and Refresh requests an earlier check.

Read the full network disclosure