ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Webサービスを提供していたり、スマートフォンアプリと連携するサーバを開発していたりすると必要になるのがWeb APIのドキュメントです。HTTPメソッド、パラメータ、返却値などが分かりやすく書かれている必要があります。

どういったドキュメントが読みやすいかは悩みどころですが、Slateは3ペインの構成になっていて見やすいのではないかと思います。ぜひご覧ください。

Slateの使い方

こちらがデモです。左が機能の一覧、中央が説明、右が実際のコードになります。
こちらがデモです。左が機能の一覧、中央が説明、右が実際のコードになります。

コードはShell、Ruby、Pythonで書かれています。
コードはShell、Ruby、Pythonで書かれています。

エラー時の内容も細かく書かれています。
エラー時の内容も細かく書かれています。

Slateは一つのMarkdownファイルから生成されています。そのため単純なHTMLとして可読可能で、それをSlateを使って3ペインのより可読性高い形式にした訳です。Markdownで書く際に予めSlateの記法に沿って書いておくと読みやすい形で表示できるようになるでしょう。

SlateはRuby製のオープンソース・ソフトウェア(Apache License 2.0)です。

API Reference

tripit/slate

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2