3 min
Public API Reference
Turn a hosted OpenAPI URL into searchable, interactive docs
Import spec URLPreviewPublish
Getting Started with Specway
From OpenAPI spec to live, interactive docs in minutes. This guide walks you through importing your spec, customizing your branding, and publishing developer docs on your own domain — no frontend code required.
5 min readBeginner friendlyLast updated: May 2026
5 Steps from Spec to Published Docs
Follow these steps to import your OpenAPI spec and publish interactive documentation. Total time: about 5 minutes.
- 1
Create Your Free Account
Sign up in seconds with Google, GitHub, or email. No credit card required — the free tier covers 1 API with 1,000 monthly page views so you can publish real docs immediately.
Pro Tips:
- Use your work email to unlock team collaboration later
- Sign in with GitHub to connect a spec repo in one click
- The free tier stays free indefinitely — no trial clock
- 2
Import Your OpenAPI Spec
Point Specway at your OpenAPI/Swagger spec — paste the JSON/YAML, upload a file, or connect a hosted spec URL or Git repo. Specway parses every operation, schema, and auth method automatically.
Pro Tips:
- OpenAPI 2.0, 3.0, and 3.1 (and Swagger) are all supported
- Connect a Git repo so docs regenerate on every push
- No spec yet? Use the free /tools/openapi-viewer to sanity-check one
- 3
Preview Your Interactive Docs
Your reference is generated instantly — searchable endpoints, request/response schemas, and a live "Try it" playground where visitors can call your API right from the page with auth handled.
Pro Tips:
- The playground pre-fills request bodies from your schema
- AI can draft missing endpoint descriptions and examples
- Code samples are auto-generated in 30+ languages
- 4
Customize Your Branding
Add your logo, colors, and fonts, then map docs to your own domain (docs.yourcompany.com). The result looks like you built it in-house — Specway just operates it.
Pro Tips:
- Custom domains and white-labeling are on paid plans
- Light and dark themes work out of the box
- Turn on SSO for private or internal-only docs
- 5
Publish and Keep It in Sync
Click Publish to go live. From here, every spec change re-generates the docs automatically, and breaking-change detection flags removed operations before your customers hit them.
Pro Tips:
- Connect a repo so docs never drift from the API
- Breaking-change alerts run on every new spec version
- Documentation analytics show what developers actually read
Quick Win Projects
Start with these to get comfortable. Each takes just a few minutes from spec to live docs.
5 min
Branded Developer Portal
Ship docs on docs.yourcompany.com with your logo and colors
Import specAdd brandingMap domain
4 min
Always-Fresh Docs
Connect a Git repo so docs regenerate on every push
Connect repoEnable auto-syncPublish
Frequently Asked Questions
Common questions from developers getting started.
Ready to Publish Your API Docs?
Import your OpenAPI spec and publish interactive docs in minutes. Free to start, no credit card required.