7

sinatra ルートから API ドキュメントを生成する宝石を一晩中探していました。インラインコメントで指定できるはずです。

https://rubygems.org/gems/sinatra-api-docsとhttps://rubygems.org/gems/sinatra-croonを見つけました

しかし、どちらも私のセットアップでは機能しないようで、古くなっています..

もう 1 つのオプションは、いくつかの sinatra プラグインを使用したヤードでしたが、ドキュメントを生成するときに REST API 固有のレイアウトを生成しません。

誰かが知っているツールを持っていますか?

各ルートについて参照したいすべての情報：

オブジェクト: グループ

ルート: POST /create

パラメータ: グループの名前

出力：

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

ありがとう

4

2 に答える 2

1

シナトラヤードを試したことがありますか？Yard にいくつかの変更を加えて、API ドキュメントを作成するために使用しました。

于 2013-03-09T13:27:12.780 に答える
1

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

于 2013-03-09T06:34:29.260 に答える