問題タブ [swagger]

RESTfulAPIドキュメントの生成に役立つツールを探しています。私のサーバーはJavaで書かれており、SpringMVCフレームワークを使用しています。サーバーにVIEWSがありません。これは100％RESTfulなサービスであり、JSONを消費してJSONを吐き出すだけです。

SwaggerがSpringアノテーションと互換性があるかどうか疑問に思いましたか？

Swaggerを使用してRESTfulインターフェイスを文書化することを検討しています。問題は、コードに注釈を付けてドキュメントを自動的に生成したくないということです。基本的に、内部データモデルをインターフェイスによって公開されている仮想データモデルに結合したくありません。サーバーにResources.jsonファイルを提供させてから、各リソースハンドラーに対応するJSONファイルを提供させることができるようです。ただし、これを試したときに、JSONの正しい構文を定義し、正しいHTTPヘッダー応答フィールドを提供しようとしたときに、多くの小さな落とし穴に遭遇しました。

誰かがこのようにSwaggerを使用したことがありますか？誰かがいくつかのドキュメントや例を持っていますか？私が見つけたすべてのものは、単にクライアントライブラリを使用してあなたのために物を生成することに集中していました。

Swagger仕様には、モデルを記述するための規定があります。

ただし、既存のSwagger-UIプロジェクトは、それを消費したり、モデルを表示したりしていないようです。ペットショップのデモを見ると、モデルが提供されているのがわかりますが、表示されていません。

私は何かが足りないのですか？それともまだサポートされていないだけですか？

プロジェクト内部で使用するための Web API をセットアップします。私たちの API を文書化する良い方法を探しています。ウェブを検索して見つけました

• IO ドキュメント
• スワガー

これらのツールは、たとえば Java 用に自動的に作成できる JSON ファイルを読み込みます。私たちの API は成長しており、JSON を手動で作成するのが好きですが、テキスト エディターで手動で作成するのは好きではありません。記述的な JSON を手動で作成する負担を軽減するツールまたはフロントエンドはありますか?

一方、Web API のドキュメント化に推奨されるツールは何ですか?

Swaggerを使用してRESTWebAPIを文書化しています。ペットショップの例をダウンロードしました。それはresources.jsonどの参照pet.jsonとuser.json：で構成されています

しかし、元のファイルをWebサーバーにアップロードした後でも、SwaggerUIは次のように通知します。

Swaggerが私のjsonファイルを見つけられない原因を教えてください。

モジュールはまだプレイサイトにリストされており、リンクは無効ですが、プロジェクトは非常にアクティブです。そのモジュールを入手したり、play 1.xでSwaggerサポートを入手したりする方法はありますか？

私はswagger uiをダウンロードし、ローカルで実験しました。"path"、"body"、"query" などのシナリオで問題なく機能します。しかし、私のユースケースのほとんどは残りのコメントを使用しています。

つまり、/resourcePath/;tags 特定のリソースのタグを取得するための URI です。

これを試してみると、セミコロンを追加するとUIがごちゃごちゃになり、並べ替えられたUIが不正になり、これを超えることはできません。

これは既知の制限ですか？この目標を達成するための回避策はありますか? これへの入力に感謝します..

Swagger のチュートリアルによると、swaggerはJerseyフレームワークのみをサポートしているようです ( https://github.com/wordnik/swagger-core/wiki/java-jax-rsを参照) 。

CXF JAX-RS実装でスワッガーを機能させた経験のある人はいますか? ここであなたの提案を共有できますか？

誰がその問題を知っていますか？SwaggerはIEをサポートできないようです。Swaggerの例をTomcatで次のようにデプロイしました。この例は、GoogleChromeとFirefoxでうまく機能します。 https://github.com/wordnik/swagger-core/tree/master/samples/no-server

ただし、IEでは例を正しく表示できません。URLは常にTomcatのインデックスページに送信されます。「localhost」をIPまたはホスト名に変更しようとしましたが、IEでは機能しません。swaggerはIEをサポートできませんか？バグですか？

ご協力いただきありがとうございます。

私のアプリケーションでは、web.xml元々、Jerseyを次のように構成していました。

これは問題なく機能しているようです。swagger-uiを使用して、注釈付きのエンドポイントのドキュメントを参照できます。

ただし、ドキュメントを閲覧する手段がそれに沿って機能するように、SwaggerUIをアプリケーションに「埋め込み」たいと思います。<url-pattern>私のJerseyサーブレットを考慮して、swagger-uiの静的コンテンツを提供する際に問題が発生しました。明らかに、それをたとえばに変更することはできますが、/api/*それは私の状況では実際には望ましくありません。

ここで、Jerseyをサーブレットではなくフィルターとして実行するように構成できること、およびURLのパラメーターを指定してJersey処理から除外できることを読みました。

それ自体でも問題なく動作します。しかし、私が闊歩をミックスに持ち込むと、物事はうまくいかなくなり始めます。具体的には、com.sun.jersey.config.property.packages次のようにサーブレット構成で行ったように、パラメータをフィルタベースの構成に導入します。

フィルタの起動に失敗し、次のエラーメッセージが表示されます。

この時点で行き詰まりました。誰か提案/ポインタがありますか？