すべてのプラグイン

OpenAPI

OpenAPI 3 および Swagger 仕様をインタラクティブなドキュメントとして描画。

ビルトイン @docmd/plugin-openapi

概要

コードブロックまたは外部URL経由でOpenAPI 3またはSwaggerのJSON/YAML仕様を埋め込みます。エンドポイント試行コンソールとスキーマエクスプローラーを備えた対話型APIリファレンスを生成します。

インストール

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

This plugin is built into docmd — nothing to install.

権限

ビルド中のこのプラグインの実行時動作:

機能使用
プロジェクトファイルの読み取りはい
site/ への書き込みいいえ
ネットワークリクエストいいえ
サブプロセスの実行いいえ

機能

このプラグインが登録するdocmdフック:

markdown body assets

タグ

apiopenapiswagger