公開操作
仕様のすべての操作を公開すべきとは限りません。管理インターフェース、内部ツール、下書き操作は文書に残しつつ、公開ドキュメントと MCP から隠す必要がよくあります。公開設定はその選択を明確にし、元文書を変更しません。
仕組み
公開設定は仕様と別に保存されます。各記録は操作を参照し有効かどうかを記録します。
- あれば操作の
operationIdを優先。 - 操作 ID のない仕様や検証のため、
methodとpathも保存。
元ファイルは不変です。ドキュメントと MCP は仕様と有効操作から生成されるため、操作を無効にすると公開面から外れ、ファイルからは削除されません。
公開ワークスペース
公開操作モードは大きな仕様を扱うために構築されています。
- 検索——メソッド、パス、要約、タグで操作を絞り込む。
- タグでグループ化——主タグでグループ分けし 、タグなしは未グループへ。
- 個別切り替え——単一操作をオン/オフ。
- グループ一括——あるタググループの全操作を一度に有効/無効。
- 全選択(フィルタ済み)——グローバルチェックボックスは現在の検索一致操作に適用。
各操作は 1 行で、複数タグ付きでも有効状態が明確です。
実用的なデフォルト
シンプルで分かりやすいのは、すべて有効から始め、公開したくない操作を無効にすることです。
- 内部・管理インターフェース(ユーザー管理や内部ヘルスチェックなど)。
- まだ設計中の操作。
- ローカルデバッグ専用のインターフェース。
選択はファイルと独立しているため、仕様自体を編集せず API の進化に合わせて変更できます。
公開と発行の相互作用
公開はどの操作が現れるかを決め、他の制御は文書がそもそも到達可能かを決めます。
- 文書は
ACTIVEでなければならない。 - ドキュメントと MCP にそれぞれ有効マーカー。
- アクセスは閲覧パ スワード(ドキュメント)かアクセスキー(MCP)で保護できる。
全ゲートはアクセス制御をご覧ください。
プラン上限
プランは公開操作数を制限します。
- Free——最大 10。
- Pro——最大 1,000。
- Team——最大 10,000。