httpie - 色付きの httpie 出力をドキュメントに保存する

Question

httpie を使用して、REST Web サービスのドキュメントを生成したいと考えています。アイデアは、コメント付きのサンプルリクエストを含むテキストを持つことです

'ping the server','http -v get :8080/ping'
'submit document','http -v post :8080/document name=asdf' 

次に、スクリプトがリクエストを実行し、適切にフォーマットされた出力をドキュメントにキャプチャします。

それを行う方法はありますか？

Answer 1

httpie 経由で作成する方法はわかりませんが、bash から html にフォーマットされた出力を取得する方法があります。この質問を参照するか、HTML::FromANSI perl モジュールまたはahaツールを使用してください。似たようなツールがたくさんあります。あなたに最も適したものを選んでください。

Answer 2

Pygments CLI ( )を使用することもできますpip install pygments。これにより、よりクリーンな HTML が提供されるはずです。また、多数の Pygments スタイルから任意のスタイルを選択するオプションも提供されます。

{

# Stylesheet:
echo '<style>'
pygmentize -S default -f html 
echo '</style>'

# Request HTTP headers as HTML:
http --print=H httpbin.org/post hello=world | pygmentize -f html -l http /dev/stdin

# JSON request body as HTML:
http --print=B httpbin.org/post hello=world | pygmentize -f html -l json /dev/stdin

}  > request.html

出力：

<style>
…
</style>
<div class="highlight"><pre><span class="nf">POST</span> <span class="nn">/post</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Length</span><span class="o">:</span> <span class="l">18</span>
<span class="na">Accept-Encoding</span><span class="o">:</span> <span class="l">gzip, deflate</span>
<span class="na">Accept</span><span class="o">:</span> <span class="l">application/json</span>
<span class="na">User-Agent</span><span class="o">:</span> <span class="l">HTTPie/0.8.0</span>
<span class="na">Host</span><span class="o">:</span> <span class="l">httpbin.org</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json; charset=utf-8</span>
</pre></div>
<div class="highlight"><pre><span class="p">{</span><span class="nt">&quot;hello&quot;</span><span class="p">:</span> <span class="s2">&quot;world&quot;</span><span class="p">}</span>
</pre></div>