RubyベースのREST APIドキュメントを生成し公開する

最近、REST APIを簡単に解析/生成/公開するために使用しているクールな子供は何ですか？私はSwaggerを見ました。それは素晴らしいですが、私の視点からはRubyにはうまくいきません。たぶん私は間違っていると私は何かが不足している、助けていただければ幸いです。RubyベースのREST APIドキュメントを生成し公開する

出典

2012-04-23 jpemberthy

セットアップには多くの作業が必要になると思われます。 –

正確には、それは素晴らしいように見えますが、避けたいと思うほどの依存性があります。 – jpemberthy

あなたはまだAPIを持っていないのですか？そうであれば、これが私が推奨するアプローチです。

swagger-specificationを使用してAPIのためのインタフェースを作成します。サーバーを使用せずにこれを行うことができます。see here
swagger-uiを使用してインターフェイスを確認します。
必要なインターフェイスを取得したら、swagger-codegenを使用して、スタブアウトされたバージョンを作成します（これは、jsonファイルを除いて、コード化されていません）。サーバ。現在、nodejsとscalatraのテンプレートがあります。新しいサーバージェネレーターを作ることは、単純に口ひげテンプレートを作成/変更することです。
また、swagger-codegenを使用してクライアントを生成することもできます。

これは、APIのインターフェイス駆動型開発を行うことができます。インタフェースを作成し、空白を記入します。配管はあなたのために行われます。

出典

2012-08-30 21:51:00 fehguy

プロトタイプのルビーサポートが利用できるようになりましたが、2008年以来維持されていないようです（https：//githubを作成するようになります）。 .com/wordnik/swagger-codegen/tree/master/samples/server-generator/sinatra – fehguy

闊歩は、私はあなたがhttps://github.com/elc/rapi_docを見てすべきだと思うが、使用することは容易ではないよりも、あなたがRoRのを使用している場合は、自動的に威張っ準拠のサーバーhttps://github.com/wordnik/swagger-codegen

からクライアントライブラリを生成するためのクライアントとしてルビーを使用することができます。

出典

2012-04-24 08:22:49 Fivell

お返事ありがとう、まあ、私は 'rapi_doc'を試してみると思います。それはスワッガーほどセクシーではありませんが、少なくともセットアップは簡単です。 – jpemberthy

rapi_docリンクが壊れています。私はそれが様々な場所で分かれていた。 https://github.com/phuc/rapi_doc –

私たちはちょうどapipieでこれを試し始めました。これまでのところはきれいに見える。

出典

2012-09-28 02:50:44

おかげさまで、将来のプロジェクトでこれを念頭に置いておきます。既に私は質問を投稿したときに私が話していたアプリのためにswaggerを使用しています。 – jpemberthy

ドキュメントについては、ApiDoco gem（https://github.com/72pulses/apidoco/）をご覧ください。セットアップが非常に簡単で、優れたユーザーエクスペリエンスを備えています。

出典

2017-04-12 04:55:28 sufinsha

RubyベースのREST APIドキュメントを生成し公開する

答えて

関連する問題