問題タブ [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.
enunciate - enunciate を使用してすべての API 呼び出しのインデックスを作成する
Jersey と Jackson を使用して、RESTful ではない API を開発しています。すべての API 呼び出しには、@Path
、@GET
/ @POST
、@Produces
および@Consumes
. enunciateを使用して素敵な API ドキュメントを生成することができました。
質問は:
すべての API 呼び出しを含むインデックスを含む単一の HTML ページを作成するよう enunciate に指示することは可能ですか?
documentation - ドキュメンテーションを宣言する "Generated by" 文を修正または削除しますか?
すべてのページで Enunciate を使用してドキュメントを生成すると、次の権限があります。
その文字列を変更または削除できますか?
jersey - @POST @FormParam + String data で Jersey API の検証が失敗することを明らかにする
REST API を文書化するために enunciate を評価していますが、検証ステップで問題が発生しています。
@FormParam バインディングに加えて、POST データを String エンティティとして受け入れるこの構成は、Jersey によってサポートされています。これは JAX-RS に準拠していませんか?
これは、何か問題が発生した場合に監査目的で完全な投稿データを取得するのに非常に役立ちます。この引数を無視するように enunciate を設定する方法はありますか?
そうでない場合は、投稿データをキャプチャして、発音を満足させる方法は他にありますか? 文字列化プロセスでは、渡された文字列が正確に得られない可能性があるため、 MultivaluedMap に行くのは気が進まない...
ありがとう!
jaxb - enunciateで型を文書化する方法は?
生成された列挙ドキュメントに入力されたタイプの説明フィールドを取得する方法は?
jaxb2-maven-plugin を使用して jaxb からクラスを生成しています。<xsd:documentation></xsd:documentation>
またはを使用して要素をどのように文書化しても
生成されたクラスで上書きされます。この自動生成された javadoc をこのプラグインから無効にすることはできますか? または、フィールドレベルで文書化できるようにするために、enunciate は実際に私に何を期待しているのでしょうか?
クラスレベル/タイプについて書いたコメントは、生成されたクラスと、宣言された生成されたドキュメントに表示されることに注意してください。
enunciate (v.1.26.2) と jaxb2-maven-plugin (v. 1.5) を使用しています。
maven - Gradle で Maven プラグイン (enunciate) を使用できますか?
素敵な API ドキュメントを生成する enunciate という Maven プラグインがあります。ビルド ツールとして Gradle を使用したいのですが、この点で制限があるように見えます。または、使い方がわからないだけかもしれません。
どういうわけかgradleでmavenプラグイン(enunciate)を使用できるかどうか疑問に思っていますか?Ant スクリプトを作成して呼び出す必要がありますか? これまでのところ、enunciate の gradle の例が見つからないので、サポートされていないと思いますか?
objective-c - /obj-c/target/enunciate/gen/ の下にあるソース ファイルはどこから来たのですか?
Macでenunciateを使用しています。Xcode コマンド ライン ツールの最新バージョンをインストールしてから、 と でコンパイラ エラーが発生しenunciate.m
ますenunciate-common.m
。これらは非常に基本的な構文エラーであり、/obj-c/target/enunciate/gen/obj-c/
ディレクトリに移動して問題のあるファイルを編集することで簡単に解決できました。だから、それは私の質問ではありません。
問題は、 を実行するたびにmvn clean install
、行った変更が破棄されることです。enunciate.m
とenunciate-common.m
ファイルがどのように生成されているかを知りたいので、ソースで問題を修正できます。自力で解いてみましたがだめでした。私はMavenの経験があまりないので、明らかな何かが欠けていると思います.Mavenがステージ.m
を実行するときにファイルが別の場所のリポジトリからプルされているようなものですか?compile