問題タブ [api-doc]

複数のパスを処理し、それに基づいてさまざまなことを実行できるサーブレットがあります。http://apidocjs.comを使用してクラス ファイル内のさまざまな関数を文書化したいのですが、2 つを表示する方法がわかりません。これを試すと（以下を参照）、最初のものだけが表示されます：

私はramlドキュメントを持っており、そのドキュメントに新しい API のドキュメントを追加しようとしています。

基本的な RAML ドキュメントを確認しました。

私はramlファイルを持っています。

そして、実際のramlコンテンツはtest.raml

上記の RAML では、400and500レスポンスが共通で、nameヘッダーが共通です。

これを一度書いて、すべてのリソースに追加するにはどうすればよいですか? 試してみましたがtraits、<<:どちらも機能しません。

docstrings を使用して Python コードを文書化し、sphinx-autodoc を使用して apidoc HTML を生成しています。私のパッケージの構造は次のとおりmainpackage.subpackage.moduleです。私の問題は、scikit-multilearnプロジェクトに由来します。たとえば、 にクラスがありますが、 にインポートしています。スフィンクスで生成された apidoc で、現在のようにではなく、このクラスのみを使用するようにしたいと考えています。誰か助けてくれませんか？mainpackage.subpackage.Classmainpackage.subpackage.module.ClassMLClassifierBaseskmultilearn.base.base__init__.pyskmultilearn.baseskmultilearn.base.MLClassifierBaseskmultilearn.base.base.MLClassifierBase

私はすでに試しました：

• Sphinx apidocごとadd_module_names = Falseに設定- パッケージとモジュールへのフル パスを表示しないconf.py

• """.. automodule:: base"""に追加skmultilearn/base/__init__.py

• __all__ = ['MLClassifierBase']に追加skmultilearn/base/__init__.py

• .. autoclass:: base.MLClassifierBaseクラスのドキュメントに追加されました

から派生するすべてのクラスに、まだBases: skmultilearn.base.base.MLClassifierBaseMLClassifierBaseがあります。これを変更するにはどうすればよいですか？

Spring Rest Doc の入門ガイドに一語一語従いましたが、生成されたスニペットから html を取得できません。

スニペットは、構成したディレクトリ ( build/generated-snippets ) で正常に生成されますが、スニペットから生成された html ファイルを含む html5/ ディレクトリが表示されません。

ドキュメントはある時点でドキュメントを jar にパッケージ化する方法を示しており、html5/ ディレクトリにいくつかのファイルが必要であることは明らかですが、これはビルドの実行時に作成されません。

私は何が欠けていますか？

私のプロジェクトファイル、build.gradle :

テストに使用する簡単なテストファイル：

私は、Spring Boot Java フレームワークを使用して、API ドキュメントの生成を自動化するプロジェクトに取り組みました。BDD/統合スタイルのテストを実行するたびに、mocha テストから作成された API ブルー プリント ファイルがありました。次に、generate-html-from-api ブループリントを実行しました。このアプローチには次の 2 つの利点があるため、気に入りました。

ノードプロジェクトの実際の例を試した人はいますか? api-doc-testプラグインを見つけましたが、そのドキュメントは限られています。? 理想的には、実行したいだけです：

これにより、api-doc.html が生成され、test/tmp/ の下に配置されます。

私はswaggerを見てきましたが、エンドポイント情報を2回指定したくありません。BDDテストで1回書くだけで、同時に2つの結果（テスト+ドキュメント）が得られるのは本当に素晴らしいことです。

nodeJS 6.x での ExpressJS 4.X の使用

以前はこの方法でルートを定義していました:

次の理由から、それが正しい方法であることがわかりました。

• ルート定義の上にルート ドキュメントを記述します
  • ルートを変更すると、ドキュメントが変更されます
• コントローラーの上にルートのドキュメントがあります
  • URL パラメータ/本文コンテンツ (req.params.name // req.body.name)
  • 返す HTTP エラー コード
  • webstorm のような IDE は、これらのコメントをオートコンプリートに使用します

ベスト プラクティスを探していると、Controller を作成し、別の場所でルート定義を作成し、次のコードで終了するように何度も言われました。

コードをこのように編成する唯一の正当な理由は、同じことを行う 2 つの道路がある場合、それらに同じコントローラを使用させることができるからです。

• コントローラーとルートを分離し続ける必要がありますか?
• はいの場合、どのように文書化すればよいですか?
• このようなコード編成の利点は何ですか?

私たちは最近、RAMLを使用して API を文書化することを決定しましたが、これまでのところすべてがうまくいっているようです。

raml2htmlユーティリティを使用して、静的な HTML ドキュメントを生成しています。デフォルトのテンプレートはうまく機能しますが、はるかに優れた API ページを見てきました。例/すぐに使用できるテンプレートのコレクションについて知っている人はいますか?

編集: RAML が進化するにつれて、その周りのツールも進化しています。最近、興味深いテーマを見つけました: https://github.com/wdullaer/raml2html-slate-theme