6

基盤となるアプリケーション アーキテクチャを文書化する方法として、またはサンプル ワークフロー/シーケンス図を説明する方法として、画像を A​​piary の API ドキュメントに統合したいと考えています。ただし、Apiary のドキュメントとAPI Blueprint Specificationを検索しても、これを行う方法についての結果は得られないようです。

API ブループリントに画像を追加することはできますか? それとも、これらの画像を外部でホストし、URL で参照する必要がありますか?

4

2 に答える 2

14

David - API Blueprint は Markdown 構文に基づいています (GitHub コメントを含む他の多くの場所と同様)。次の構文を使用して、画像を Markdown (および API ブループリント) に挿入できます。

![name](/url)

これらの画像は実際に外部でホストされ、URL 経由で参照される必要があります。

于 2015-12-15T01:38:55.660 に答える