Rails routes.rbファイルを使用してAPIリファレンスドキュメントを生成する最適な方法は何ですか？

私はRailsアプリケーションのAPIを文書化しようとしていますが、routes.rbファイルに基づいてXMLファイルを生成するより良い方法があるのだろうかと思っています。私はrake routesの出力に似ていますが、よりフレンドリーなXMLタイプの形式で構想しています。 Coreyには、ルートファイルに反射/イントロスペクションを使用することについての興味深いアイデアがありますが、それは私が必要とするものではありません。Rails routes.rbファイルを使用してAPIリファレンスドキュメントを生成する最適な方法は何ですか？

これは解決された問題であり、私はこれを考えるのは初めてではないことを教えてください。

https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake

おそらく、あなたはそれから関連する事柄を学び、（-cough-）より親しみやすいXML形式でルートを生成するための新しいタスクを作成することができます：:)

出典

2011-01-03 Richard Hurt

APIリファレンスの追加要件や計画がある場合は、質問を洗練できますか？ – Heikki

rake routesは、通常のrakeタスクです。 ;）

出典

2011-01-03 20:44:50 Heikki

あなたが探しているもの（私にも驚きました）と完全に一致するものは見つかりませんでしたが、あなたが望むものを使い始めるにはa sitemap gemを見てください。これはカスタムコードでなければならないかもしれません...悲しいことに

出典

2011-01-03 20:52:39 brycemcd

'rake routes'が28行のコードであると考えると、それはあまりにも重要な仕事ではないかもしれません。 – Heikki

彼は、APIを文書化するためのXMLファイルを生成しようとしています。私は、要件の一部がレイク全体がルートファイルがAPIの一部ではないということを推測しました。また、rakeファイルはSTOUTにパイプされ、XMLファイルが必要です。私はちょうど、サイトマップジェネレータが始めるには良い場所だと考えました。 – brycemcd

事を満足させる複雑な仕様の良い例です。 'rake routes'のコードはすべてのルートも出力しないことに注意してください。 BuilderでXMLを生成し、それをファイルに書き込むことは簡単に言えません。 – Heikki

Rails routes.rbファイルを使用してAPIリファレンスドキュメントを生成する最適な方法は何ですか？

答えて

関連する問題