OpenScan logo OpenScan

Beautiful API docs
in one command

View, explore, and share your OpenAPI specs instantly.

View demo
OpenScan preview showing API documentation interface
$ npx openscan ./openapi.json

✓ Loaded OpenAPI spec

✓ Starting server...

→ http://localhost:3000

How it works

1

Run the command

Point to any local file or remote URL

2

Preview instantly

Beautiful docs open in your browser

3

Export and share

Get a public URL or build static files

Why OpenScan?

A better developer experience for exploring APIs.

Zero setup

No login, no config files, no dependencies. Run one command and you're done.

Local or remote

Works with local files or any remote OpenAPI URL. JSON or YAML, it just works.

Instant sharing

Generate a public URL with one flag. Perfect for code reviews and client demos.

Static export

Build to static HTML and host anywhere. No vendor lock-in, no ongoing costs.

Self-hostable

Run on your own infrastructure. Keep your API specs private and secure.

Clean design

Modern, readable interface with dark mode. Makes complex APIs easy to explore.

Ready to try it?

One command. Beautiful docs. No signup.