Micron Document
MeshAPI
OpenAPI for the Reticulum mesh

MeshAPI is a small, open way to describe an API that runs over Reticulum, and to document it with interactive pages you browse right here on the mesh. If OpenAPI and Swagger are to HTTP, MeshAPI is to RNS and micron.

A service publishes one manifest, a compact description of its operations (requests, responses, auth). From that single manifest, both a machine-readable description and a human-readable, try-it-yourself page are generated, so the docs can never drift from the API.


Why it exists

Reticulum already has everything needed to run APIs: authenticated, encrypted Links with a request/response API, and NomadNet pages for docs. What it lacked was a shared way to describe those APIs and generate docs from that description. MeshAPI fills that gap. It is a description layer, kept deliberately separate from any framework that builds services (the same split as OpenAPI versus web frameworks).


What you get

A tiny manifest format (umsgpack on the wire, JSON for humans)
Discovery: any client can ask a service for _manifest__and learn its whole API
Interactive docs: a NomadNet page listing every op with a live "try it" form
Auth levels built on Reticulum identity (public, identity, allow-list)
A reference Python package to describe, serve, render, and call


Read on
Live services using MeshAPI

> rns-geo, geolocation (browse its live explorer)


Source https://github.com/wdunn001/meshapi
MeshAPI 0.1, an open pattern for the Reticulum community