Apidogは、APIドキュメントの作成だけでなく、Markdownコンテンツをドキュメント内に直接組み込むことも可能。MarkdownドキュメントはAPIドキュメントとシームレスに統合・表示できる。単独のMarkdownドキュメント#
任意のAPIフォルダに、プラス(+
)ボタンをクリックして単独のMarkdownドキュメントを追加できる。エディタでMarkdownを書き、右側のプレビュー画面で即座にレンダリング結果を確認できる。API内でのMarkdown利用#
各APIの説明欄でもMarkdownが利用可能。ここに記述したMarkdownは、APIドキュメント上で整形されたテキストとして表示され、APIの説明を分かりやすく、視覚的にも魅力的にできる。フォルダ単位のMarkdown#
Apidogでは、フォルダ単位でMarkdownコンテンツを追加することもできる。設定すると、ドキュメント上でフォルダ名をクリックした際に、そのフォルダのMarkdownコンテンツが表示される。フォルダ単位のMarkdownを追加しない場合、フォルダ名をクリックすると単に中身が展開されるだけとなる。フォルダ単位のMarkdownを追加するには、ApidogでAPIフォルダ名をクリックし、「ドキュメント」タブに移動してMarkdownコンテンツを入力する。Apidog独自のMarkdown拡張#
ApidogのMarkdownでは、カード、アコーディオン、フレームなど、さまざまな拡張スタイルに対応。これらのカスタムコンポーネントを使うことで、よりリッチでインタラクティブなドキュメント体験を実現できる。Markdownエディタの「挿入」ボタンから、利用可能 な要素を簡単に選択・挿入できる。 Modified at 2025-07-10 09:45:30