API documentation

Your API reference, always in sync

Point Zuwiki at an OpenAPI or GraphQL schema and get a clean API reference on the same domain as your guides. When the schema changes, the docs follow.

OpenAPI and GraphQL

The format is detected automatically, and you can override it when needed.

Request samples

Choose which languages readers see and which tab opens first.

Stays up to date

Set how long a fetched schema is cached and refresh it on demand after a release.

Included in every plan, including Free.Compare plans

From schema to reference

No build pipeline, no extra hosting.

  1. 1

    Add an API subwiki

    API references live next to your guides and changelog, switchable on the same domain.

  2. 2

    Paste your schema URL

    Use any publicly reachable OpenAPI or GraphQL schema. Zuwiki renders it on visit.

  3. 3

    Add context

    Write an intro in Markdown, set the base URL and decide whether deprecated routes are shown.

Docs that never fall behind the code

The usual way

  • Endpoints are copied into the docs by hand and drift apart.
  • A separate API portal on a separate domain with a separate login.
  • Deprecated endpoints confuse new integrators.
  • Request examples only exist for one language.

With Zuwiki

  • The reference is rendered from the schema you already maintain.
  • Guides, reference and changelog on one domain with one search.
  • Hide deprecated routes with a single switch.
  • Readers pick the sample language that fits their stack.

For every API audience

SaaS

Public APIs

A reference your customers can explore, right next to the guides that explain it.

Platform teams

Internal services

Document internal APIs in a protected wiki, so only your teams can read them.

Developers

Side projects

Publish the reference for your project on the free plan, on your own domain.

Questions and answers

More from Zuwiki

API documentation from OpenAPI and GraphQL | Zuwiki