問題タブ [swagger-ui]
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.
servicestack - 最新の ServiceStack Swagger-ui NuGet パッケージ (v 4.0.30) は、swagger-ui リソース フォルダーをデプロイしません
Swagger-UI で ServiceStack を使用していたプロジェクトがあり、これを v4.0.24 でインストールしてセットアップし、最近 v4.0.30 にアップグレードしました。
最新の ServiceStack.Api.Swagger NuGet パッケージ: https://www.nuget.org/packages/ServiceStack.Api.Swagger/ 以前のパッケージのように /swagger-ui リソース フォルダーをインストールしていないようです。
VS2013 の新しいクリーンな servicestack asp.net ソリューションでこれを試しました。nuget から ServiceStack.Api.Swagger を追加し、AppHost.cs でプラグインを有効にしました。
swagger-ui 機能は正常に動作しているように見えますが、リソース (index.html、js、css など) が dll に埋め込まれているようで、Swagger を構成するには最低限 index.html を編集する必要があります。 UI。
何か不足していますか、それとも最新の NuGet パッケージのバグですか?
swagger v4.0.24 html、css、および js を編集しました。これらを ServiceStack Git ( https://github.com/ServiceStack/ServiceStack/tree/master/src/ServiceStack.Api.Swagger )から安全にプルできますか?それらを手動でソリューションに追加/マージしますか?
c# - エンドポイントとクラスのドキュメントのための Web Api での Swagger UI のセットアップ
VS2013 には、いくつかのクラス ライブラリと Web API プロジェクトを含むソリューションがあります。Swagger UI をセットアップするときに、いくつかの問題が発生しています。まず、Web API プロジェクト用に swashbuckle をセットアップするとき、1 つのドキュメント XML ファイルしか参照できません。Swagger がコントローラー内のルートのドキュメントだけでなく、他のプロジェクトのドメイン オブジェクトも取得できるように、複数の XML ファイルを含めるように指定する方法はありますか? ここに SwaggerConfig.cs からの私のコードがあります
複数の XML ファイルを追加すると、IncludeXmlComments から最後のファイルのみが取得されます。
次に、JSON で返すときに DTO にキャメル ケースを使用しています。
しかし、Swagger UI の応答クラスで応答モデルとモデル スキーマを見ると、エンドポイントがヒットしたときに返される JSON スキーマではなく、正確なクラス プロパティ名が表示されます。Swagger UI ドキュメント ページに正確な JSON スキーマを表示する方法はありますか?
ruby-on-rails - swagger_doc.json が間違った swagger doc の URL を返す
私のhttps://xy/api/swagger_doc.jsonはこれを返します:
パスが /ping.{format} を指していることに注意してください。これは、/swagger_doc/ping.json を指している必要があります。このため、swagger ui で次のエラーが表示されます。
ping.json フォームhttps://xy:443/api/swagger_doc/ping.jsonに手動でアクセスできます。コンテンツは、swagger ui に必要なものです。
この謎を解決するためのアイデアをいただければ幸いです。
web-services - Swagger は SOAP に使用できますか?
私はSwaggerを探求していましたが、私はそれを愛していることを認めなければなりません。
Swagger は主に RESTful Web サービス向けであることは理解していますが、SOAP Web サービスでも動作するようにできないかと考えていました。SOAP ベースの Web サービスを RESTful に変換できますか? それとも、単に Swagger UI を介して SOAP ベースのサービスを呼び出しますか? いくつかのハック？誰かがやったことがありますか？
json - Swagger-UI での動詞レベル モデル/モデル スキーマのオーバーライド
API ドキュメントを標準化するために、swagger-ui を使用しています。body パラメーターを使用するため、モデルとモデル スキーマを表示する必要がある動詞 (GET、PUT、POST など) の場合、スキーマはリソース レベル (/pet またはペット ストアの /store) で定義されていることに気付きました。例）。ただし、API 内では、必要な body パラメーターは動詞ごとに変化するため、これを正確に反映するそれぞれのモデルがあると便利です。
http://petstore.swagger.wordnik.com/api/api-docs/petのモデル定義の現在のバージョン。モデル定義は次のようになります。
動詞レベルで既定のリソース レベル モデルをオーバーライドする方法はありますか?
php - swagger-ui から Restler メソッドを隠す
内部で swagger-ui をパッケージ化する Restler 3.0.0-RC6 を使用して、API メソッドを次のように定義しました。
そして、Restler のaddAPIClass拡張を介して含めるすべてのクラスは、その PostgreSQL クラスを拡張します。つまり、swagger が実行されると、すべての API が fetchArray 関数を表示します。そのメソッドは実際には API の一部ではないため、swagger のドキュメントに表示されないようにしたいと思います。ただし、Web サイト上の他の「もの」もクラスを使用するため、修飾子を public から変更することはできません。
そのメソッドをswagger-uiのWebページから隠すための適切な構文は何ですか?
swagger - static swagger service.json に基づいてモック実装を生成することは可能ですか?
Carma swagger-jaxrs-doclet を使用して、 maven ビルド サイクル中にswagger service.jsonおよびその他のresource.jsonを生成しています。その後、成果物を swagger-ui と共に Web サーバーにデプロイすると、生成されたドキュメントを参照できます。これは、アプリケーションで swagger Bean をデプロイしていないことを意味します。
swagger は主に API 実装に沿ってデプロイされるため、swagger-ui がドキュメントを実行可能にするためにどのアプローチを取るのか疑問に思っていました。swagger-ui ドキュメントから実際の実装にリダイレクトしますか、それともservice.json に基づいてモック バックエンドを作成しますか? service.json に基づいて node.js でバックエンドを作成できることを読みましたが、Web ページでそれを行う方法がわかりません。Web ページ内から可能であれば、私は今でもしませんか?