gemによるAPIドキュメント

エンドポイントの入出力の変更を自動的に検出してAPIを文書化し、APIを詳しく説明したドキュメント（HTMLなど）を生成することができる宝石があるかどうかを調べたいと思いますスタイルはgemによるAPIドキュメント

https://dev.twitter.com/docs/api/1/get/statuses/home_timelineです。

2012-01-24 Freemason

ほぼ100％そのようなものはないと確信しています。そのような変更を自動的に検出するメタデータがあまりにも少ないので、特にRailsではありません。 – Tigraine

同じ質問http://stackoverflow.com/questions/10289024/generate-and-publish-ruby-based-rest-apis-documentation/10294257 ＃comment13253524_10294257 – Fivell

ApiDoco gem https://rubygems.org/gems/apidoco/versions/1.2.0でrails 5 apiのドキュメントを確認してください。セットアップが非常に簡単で、優れたユーザーエクスペリエンスを備えています。 – HTB

これは、私の知る最も近いものであるが、それはで焼いたドキュメントを使用してAPIを構築するためのツールのアドオン宝石の少ない、よりだ：、限り宝石が懸念しているようhttps://github.com/mattetti/Weasel-Diesel

出典

2013-03-12 07:50:51

apipie-railsはいいです。変更自体は自動的には検出されませんが、単純な注釈構文があります。テストに基づいてドキュメントを自動的に生成することができ、繰り返し使用されるparamグループなどのDRYヘルプを提供しています。

今のところまったく別のものについて... apiaryは、APIのマークダウンの青写真（レポのルートで管理されています）に基づいてたくさんのおいしさを提供します。 apiaryがドキュメンテーション、コードサンプル、コミュニティのコメント、さらに必要に応じてプロキシAPIサーバーを提供していることを考えると、青写真を維持することは恐ろしい価格ではありません。

出典

2013-05-19 00:21:23 chrislopresto

最近、私はいくつかのプロジェクトでhttp://readme.io/ + http://apidocjs.com/を使用しました。宝石ではありません。無料ではありません。しかし、優れた価値。 – chrislopresto

gemによるAPIドキュメント

答えて

関連する問題