問題タブ [api-doc]

Symfony 2.3.4 と FOSRestBundle 0.13.1 を使用しています。ルートが FOSRestBundle によって自動生成されるように構成しました。@QueryParam アノテーションを任意のメソッドに追加するまで、すべてがうまく機能します。このアノテーションはルートを変更し、変数を URL から抽出する代わりに、パラメーターとして渡されることを期待します。

すなわち

しかし、@QueryParam アノテーションを追加するとすぐに、ルートが次のように変更されます。

ルートが変更されるのはなぜですか? 元のルートを保持し、同時に @QueryParam アノテーションを使用することはできませんか?

このタイプの API ドキュメントを Doxygen で生成することは可能ですか? もしそうなら、どのように？

すべてのコントローラーに XML コメントを付けています。

これまでのところ、 django-rest- swagger が v0.1.10 から Markdown 構文で docstring をサポートしていることを知っています。しかし、ドキュメントを見ようとすると、解析して HTML コードに変換するのではなく、プレーン テキストとして表示されます。

私は使用しています：

API サンプル コード関数ベース ビュー:

API を直接参照すると、説明が適切に翻訳/レンダリングされます。

何か不足していますか？

setuptools を使用し、次の構造を持つデモ プロジェクトを作成しました。

Sphinx を使用して、このプロジェクトのドキュメントを自動生成しようとしています。これまでのところ、私は試しました：

README、setup.pyおよび docstringを使用して、このドキュメントを自動生成する簡単な方法が必要だと思います。

最終的には、Python C-api も使用する別のプロジェクトの apidoc を自動生成したいと考えています。これについては何も見つかりませんでした。

私の主な質問は: このドキュメントを自動生成する簡単な方法はありますか?

私swagger-springmvcは自分のプロジェクトに含め、Swagger UI を機能させることができましたが、現在、UI の API に関する情報はほとんどありません。私が見るのは反射によって抽出された情報だけです。

コントローラ メソッドは次のようになります。

そして、各メソッドの右側に Swagger はメソッドの名前を文書化します。この場合:

しかし、私はこれを見ることを期待していました:

helloreverb.com の例では、これらの各メソッドの説明を確認できます。コントローラーメソッドの説明をUIに追加するにはどうすればよいですか?

「リモート可能なオブジェクト」について話すとき、Android API ドキュメントは何を意味しますか?

たとえば、IBinder状態の API ドキュメントは次のとおりです。

このインターフェイスは、リモート可能なオブジェクトと対話するための抽象プロトコルを記述します。

しかし、私は検索しましたが、「リモート可能なオブジェクトは...何とか何とか何とか...」などの定義を見つけることができないようです。