# 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)
- [Organize with Categories](https://docs.zuwiki.com/getting-started/organize-with-categories)
- [Publish Your First Page](https://docs.zuwiki.com/getting-started/publish-your-first-page)

### 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 Visual Touches](https://docs.zuwiki.com/editor-guide/icons-and-visual-touches)
- [Rich Content Blocks](https://docs.zuwiki.com/editor-guide/rich-content-blocks)
- [OpenAPI Pages](https://docs.zuwiki.com/editor-guide/openapi-pages)

### Plans & Account

- [Plans and Limits](https://docs.zuwiki.com/plans-account/plans-and-limits)
- [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

Most pages are Markdown. A page can also be an **OpenAPI page**, which turns a published OpenAPI specification into a browsable API reference inside your wiki. You point it at a spec URL and Zuwiki renders the endpoints, parameters, and responses for you, so the reference stays in sync with the spec instead of being copied by hand.

## Creating one

In the editor sidebar, add a new page and choose the **OpenAPI spec** type instead of a normal page. Then fill in the settings:

- **URL** (required): the public address of your OpenAPI specification. Zuwiki fetches it and shows the title, version, and how many endpoints it found, so you can confirm you picked the right one.
- **Base URL** (optional): the server that example requests should point at. If you leave it empty, the first server from the spec is used. Set it when the spec has no server or when you want readers to target a specific environment.
- **Show deprecated**: a toggle that decides whether endpoints marked deprecated appear in the reference.

Like any page, an OpenAPI page is a draft until you publish it.

## What readers see

An OpenAPI page renders as a small reference of its own:

- An **overview** with the API title, version, and description, and the endpoints grouped by their tags.
- A **detail view per endpoint** showing the method and path, parameters, request body, every response, and ready to copy code samples built for your base URL.

Readers navigate from the overview into individual endpoints, the same way they move through the rest of the wiki.

## Requirements and limits

- The spec must be reachable at a **public URL**. Addresses on private or local networks are rejected.
- The spec is read as **JSON**.
- **OpenAPI 3.0 and 3.1** are fully supported. **Swagger 2.0** is handled on a best effort basis.
- The spec is fetched within a short timeout and then cached for a few minutes, so a change at the source shows up shortly after, not instantly.

## When to use it

Reach for an OpenAPI page when you already maintain a spec and want the reference to track it automatically. If you only need to describe a handful of calls, a normal Markdown page with code blocks is simpler. The two mix well: keep guides and concepts in Markdown and let the OpenAPI page carry the exhaustive endpoint list.