外部開発者向けの API を提供する Web サイトに取り組んでいます。
API が更新されるたびに (パラメーターの変更、新しいエンドポイントなど)、ドキュメントを手動で更新する必要があります。
そこで、このプロセスを自動的に行う方法を検討しています。これが私が達成したいことです。ソース コードが更新され、ソース管理にコミットされると、ある種の API レジストリが更新されます。したがって、私のドキュメントは、レジストリを参照し、最新の API を使用してビューアーを表示するアプリにすることができます。
私のサイトは Ruby on Rails に基づいています。
RDoc はソース コードに基づいて自動的に生成され、Rails にデフォルトで付属しています。コードは十分に文書化する必要がありますが、文書化されている場合は、実行するだけです
bundle exec rake doc:app
アプリは からアクセスできるドキュメントを生成しますdoc/app/index.html。私はそれを見て、そのようなドキュメントがあなたのニーズに合っているかどうかを確認します. 「クラスとモジュールのインデックス」サイドバーのリンクには、すべてのメソッドのリストと、それらのソース コードの展開可能なビューが含まれています。
カスタム rake タスクを使用して、そのすべてのドキュメントを Rails パブリック フォルダーに配置し、Web サイトから直接アクセスできるようにし、複数のカスタム ページを追加できるようにします。API ファイルのみを解析する同様のことを行うのはそれほど難しくないと思います。
リンク: