2013-03-09 17 views
7

私はsinatraルートからAPIドキュメントを生成するために徹夜を探しています。私はインラインコメントで指定できるはずです。Sinatra build REST APIのドキュメント

私はhttps://rubygems.org/gems/sinatra-api-docs & https://rubygems.org/gems/sinatra-croon

を発見したが、両方はちょうど私のセットアップで機能していないようですし、あまりにも時代遅れ..です

他のオプションは、一部のシナトラのプラグインとの庭だったが、それはしませんドキュメントを生成するときにREST API固有のレイアウトを生成します。

誰でも知っているツールはありますか?

私は各ルートのために参照するすべての情報:

オブジェクト:グループ

ルート:POST /作成

のparams:

:グループ

出力の名前

{ 
    "name": "group", 
    "members": [] 
} 

ありがとう

答えて

1

私はApiary.ioをチェックアウトしていますが、これはかなりうまく設計されていて、Markdownスタイルのドメイン固有の言語を使用してAPIを記述しています。まだベータ版では無料です。

1

Sinatra Yardを試しましたか?私は、APIドキュメントを作成するためにYardにいくつかの変更を加えて使用しました。

関連する問題