問題タブ [enunciate]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
java - enunciate を使用して、マルチモジュール pom に対して実行しているときに、1 つのページからすべての残りの API をリンクするにはどうすればよいですか?
マルチモジュール pom に対して mvn enunciate:docs を実行できます。ここで、モジュールはサービスの完全な実装であり、サイトはそれらのそれぞれの下に作成されます (例: service1/rest/api/target/site/wsdocs/index.html ) しかし、残りのすべての API を enunciate を介して 1 つのページにリンクしたいと思います。
API とサンプルの xml/json メッセージ本文を生成するために enunciate のみを使用しています。
これは可能ですか、それともスクリプトを使用して自分でサイトを作成する必要がありますか?
ありがとう。
java - リスト、配列、マップなどのメッセージ本文の例xml / jsonをenunciateで生成しますか?
enunciateを介してRESTAPIドキュメントを生成することができ、メッセージ本文用に生成されるxmlとjsonの例が本当に気に入っています。しかし、リスト、配列、マップなどのそれらを生成する方法を見つけることができません。
私はmavenを使用しており、ビルドプラグインのmavenノード内にdocsゴールを持つenunciateプラグイン(通常)で構成されています。
これは可能ですか?
ありがとう。
java - APIクラス内の多次元配列に関するenunciateの回避策はありますか(docs maven goal)?
maven plugin enunciate の docs goal を実行すると、「多次元配列はまだサポートされていません」というエラーが表示されます。プロセスを爆破するのを避ける方法はありますか (つまり、API の残りのドキュメントを生成します)?
double 配列のクラスを返す API メソッドで @org.codehaus.enunciate.doc.ExcludeFromDocumentation を試しました。double 配列を持つクラスで @org.codehaus.enunciate.XmlTransient を試しました。
それ以来、コンパイルではなく、ドキュメントに表示されるかどうかにのみ影響する enunciate ドキュメントを見てきました。
アイデアがあれば教えていただけると嬉しいです!
ありがとう。
編集:私ができる最善のことは、プロジェクトを一時ディレクトリにダンプし、API に到達するために必要のないすべてのモジュールを取り除き、クラスを double 配列で削除し、REST API の Java メソッド署名のその部分を文字列に置き換えることでした。これにより、少なくとも enunciate を介して API ドキュメント ページを作成し、javadoc を介して説明を与えることができます。しかし、もっとエレガントなソリューションが欲しいので、知っている場合は共有してください:)
編集 2: pom の例:
src/main/java/com/company/services/user/rest にあるファイル:
enunciate.xml:
java - Enunciateで生成された構成ファイルを変更して、CXF用の最新のjacksonライブラリを使用します
Enunciate
cxf-jaxrs-servlet.xml
ファイルを自動的に生成し、プロバイダーorg.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider
として:を指定します。このクラスは、最新のライブラリでJAX-RS
に変更されました。自動生成されたファイルでプロバイダーとして新しいクラスを指定するにはどうすればよいですか?または、ユーザー提供のファイルを使用させることはできますか?com.fasterxml.jackson.jaxrs.JacksonJaxbJsonProvider
Jackson
Enunciate
JSON
Enunciate
XML
rest - REST API ドキュメントの enunciate と ant の統合
CXF REST サービス API プロジェクトの enunciate と ant の統合中にエラーが発生しました。メソッド getFeeItemsByCapID() にエラーがあります。ソースコードで答えを見つけようとしますが、結果はありません。エラーについて誰が考えていますか? ご協力いただきありがとうございます。何かヒントがあれば。
Ant スクリプト
Enunciate.xml
Java コード
例外:
ソースコード:
java - JAXBElementを認識しないことを発音します
完全に機能し、テスト済みのRESTAPIがあります。ドキュメントを作成するために、私はenunciateを使用しています。
要求と応答のオブジェクトは、jaxbを使用してxsdファイルから生成されます。ドキュメントでは、応答オブジェクトは認識されますが、リクエスト本文のタイプは(カスタム)です。
リクエスト本文はJAXBElementにカプセル化されています
コード例:
@TypeHint
リクエストオブジェクトのタイプを指定するようなアノテーションはありますか?
java - 一部の jaxb 生成クラスを enunciate から除外する
enunciate を使用しており、jaxb で生成された特定のクラスをドキュメントから除外したいと考えています。これはどのように行うことができますか?
xsd を介して org.codehaus.enunciate.XmlTransient アノテーションを追加することは可能ですか?
前もって感謝します。
ant - ant を使用して REST API ドキュメント生成を明示する
Enunicate を統合して、既存の API の REST ドキュメントを生成しようとしています。
「警告: アーティファクト 'ドキュメント' が不明です。アーティファクトはエクスポートされません。」という警告が表示されます。Ant タスクの実行時。
セットアップに欠けているものはありますか?
enunicate.xml は次のとおりです。
関連する ant フラグメントは次のとおりです。
ありがとう
金星
java - 出力を微調整するためのドキュメントを宣言する
ennuciate は JAXB REST Web サービスの文書化に適していることがわかりましたが、生成された出力を微調整する方法に関する最小限の文書があるようです。
Web サービスのパラメーターと許容値のリストを記述するために使用できる注釈の明確なリストはありますか。
ドキュメント生成コードがクラスをデータ型とデータ要素に分割する方法が明確でない
ありがとう
ゴードン
maven - maven-enunciate-plugin NullPointerException 生成ドキュメント
maven-enunciate-plugin:1.26.2:docs を実行しようとしていて、NUllPointerException に直面しています。
私が欲しいのは、ここで説明されているドキュメントの生成だけですhttp://docs.codehaus.org/display/ENUNCIATE/Documentation+Only、したがって、私の pom.xml は次のとおりです。
しかし、それは起動します:
なにか提案を?