# Zuwiki

## OpenAPI pages

> Category: Editor guide

---

## Pages

- [Welcome to Zuwiki](https://docs.zuwiki.com/welcome-to-zuwiki)

### Getting started

- [Create your first wiki](https://docs.zuwiki.com/getting-started/create-your-first-wiki)

### Core concepts

- [Wikis, categories, and pages](https://docs.zuwiki.com/core-concepts/wikis-categories-and-pages)
- [Page lifecycle](https://docs.zuwiki.com/core-concepts/page-lifecycle)
- [Page history and restore](https://docs.zuwiki.com/core-concepts/page-history-and-restore)

### Access & Sharing

- [Public vs internal wikis](https://docs.zuwiki.com/access-sharing/public-vs-internal-wikis)
- [Visibility for public wikis](https://docs.zuwiki.com/access-sharing/visibility-and-access)
- [Share links](https://docs.zuwiki.com/access-sharing/share-links)
- [Access grants](https://docs.zuwiki.com/access-sharing/access-grants)
- [Classification and sensitivity](https://docs.zuwiki.com/access-sharing/classification-and-sensitivity)

### Editor guide

- [Markdown basics](https://docs.zuwiki.com/editor-guide/markdown-basics)
- [Linking between pages](https://docs.zuwiki.com/editor-guide/linking-between-pages)
- [Icons and images](https://docs.zuwiki.com/editor-guide/icons-and-images)
- [Rich content blocks](https://docs.zuwiki.com/editor-guide/rich-content-blocks)
- [OpenAPI pages](https://docs.zuwiki.com/editor-guide/openapi-pages)

### Plans & Account

- [Custom domain](https://docs.zuwiki.com/plans-account/custom-domain)
- [Zuwiki for open source](https://docs.zuwiki.com/plans-account/zuwiki-for-open-source)

### Integrations

- [MCP Server](https://docs.zuwiki.com/integrations/mcp-server)

---

# OpenAPI pages

An OpenAPI page turns an OpenAPI specification into a browsable API reference inside your wiki. You give it the URL of your spec, and Zuwiki renders endpoints, parameters and responses from it, so the reference follows the spec instead of being copied by hand.

## Creating one

Add a page in the editor sidebar and choose the **OpenAPI spec** type. Then fill in:

- **URL** (required): the public address of your specification. Zuwiki fetches it and shows the title, version and number of endpoints, so you can check you picked the right file.
- **Base URL** (optional): the server that example requests should use. If you leave it empty, the first server in the spec is used. Set it when the spec has none, or when readers should target a particular environment.
- **Show deprecated**: whether endpoints marked as deprecated appear.

Like every page, it is a draft until you publish it.

## What readers get

An overview with the API's title, version and description, with endpoints grouped by tag. Each endpoint has its own view with method and path, parameters, request body, all responses and code samples you can copy, built for your base URL.

## Requirements

- The spec must be reachable at a public URL. Private and local network addresses are rejected.
- It must be JSON.
- OpenAPI 3.0 and 3.1 are fully supported. Swagger 2.0 mostly works.
- Zuwiki caches the spec for a few minutes, so a change at the source appears shortly after, not instantly.

## When to use it

Use it when you already maintain a spec and want the reference to keep up with it. To describe just a few calls, a normal page with code blocks is simpler. The two mix well: keep guides and concepts in Markdown and let the OpenAPI page hold the full list of endpoints.
