Aperio

Publish

How to document your API with Aperio

Aperio is a free OpenAPI docs engine — not a paid seat-based portal. You keep the spec; we render interactive documentation. Pick the path that fits you.

01

Use the free playground

Best for demos, reviews, and internal sharing. Paste or upload OpenAPI and get interactive docs instantly.

Open playground →

02

Embed on your website

Best for public product docs. Host your openapi.json on your domain, then iframe Aperio embed. Docs update when your spec updates.

See embed example →

03

Self-host Aperio

Best for full control and branding. Clone the MIT repo, deploy on Vercel or Node, put it on docs.yourcompany.com.

Self-host guide →

Embed snippet

Host your OpenAPI at a public URL, then add this to your docs site:

<iframe
  src="https://aperio-nine.vercel.app/embed?url=https://YOUR_API.com/openapi.json"
  style="width:100%;height:80vh;border:0;border-radius:12px"
  title="API Reference"
></iframe>

Before you publish

  1. Export OpenAPI from your API framework (or write openapi.yaml)
  2. Lint the spec for missing servers, operationIds, responses
  3. Preview in the playground
  4. Embed or self-host for a permanent home
Start with your OpenAPI