All plugins

OpenAPI

Render OpenAPI 3 and Swagger specs as browsable docs.

Built-in @docmd/plugin-openapi

Overview

Embed any OpenAPI 3 or Swagger JSON/YAML spec via a fenced code block or external URL. Generates interactive API reference pages with endpoint try-it-out consoles and schema explorers.

Installation

# OpenAPI ships with docmd — nothing to install. docmd build

This plugin is built into docmd — nothing to install.

Permissions

Runtime behaviour of this plugin during a build:

CapabilityUsed
Reads project filesYes
Writes to site/No
Network requestsNo
Runs subprocessNo

Capabilities

docmd hooks this plugin registers:

markdown body assets

Tags

apiopenapiswagger