問題タブ [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.
swagger - Swagger(OpenAPI)でファイルを投稿する方法は?
Swaggerを使用してRESTサービスを文書化しています。私のサービスの1つでは、CSVファイルをアップロードする必要があります。parameters
JSONAPI定義のセクションに以下を追加しました。
SwaggerUIページにファイルアップロードオプションが表示されます。しかし、ファイルを選択して[試してみる]をクリックすると、次のエラーが発生します。
NS_ERROR_XPC_BAD_OP_ON_WN_PROTO:jquery-1.8.0.min.jsのWrappedNativeプロトタイプオブジェクトに対する不正な操作(2行目)
ページは継続的に処理されており、応答がありません。
何が間違っている可能性があるのか?
servicestack - ServiceStack Swagger NuGet パッケージが不完全です
ServiceStack プロジェクトに ServiceStack.Api.Swagger NuGet パッケージを実装しようとしていますが、Index.html に示されている jquery と handlebars スクリプト ファイルの両方が /swagger-ui/lib フォルダーにありません。
jquery の問題は軽減できましたが、ハンドルバーの問題が妨げになっています。handlebars-1.1.0.js を追加して Index.html で参照すると、次のようになります。
テンプレートは、現在のランタイムよりも古いバージョンのハンドルバーでプリコンパイルされました
このパッケージがどのように機能するはずなのか、ここで何か不足していますか? 起動して実行するには、限られた構成が必要だと思っていましたが、スクリプト エラーをスローせずに Index.html をレンダリングするために何時間も費やしました。
servicestack - Servicestack で Swagger UI からエンドポイントを非表示にするにはどうすればよいですか?
ServiceStack 3.9.59.0 の Swagger プラグインを使用しています。Swagger UI に表示したくない ServiceStack API に、/selfchecknode などのいくつかのエンドポイントがあります。
おそらくコントラクト属性を介して、特定のエンドポイントが Swagger に表示されないようにするために使用できる宣言的な方法はありますか?
c# - 自己ホスト型サービススタック内で Swagger プラグインを動作させる方法
github で提供されている例と、コードを自分で実行したい人のためのドロップ ボックス ダウンロード リンクを使用して、この質問を再質問しました。
Web サイト ソリューション内の '/api/ パスの下で servicestack JSON サービスを実行していましたが、そのサービス スタック部分を分割して、自己ホスト型 Windows サービスとして実行したいと考えています。私の問題は、私自身と他の開発者が Swagger プラグインがテスト目的で非常に便利であることを発見したことですが、自己ホストされているため、HTTPHandler はサービス ルートを処理するためだけに設定されているように見え、プレーンな HTML は機能しません。
これを修正するにはどうすればよいですか?
URL :http://localhost:8081/Swagger-UI/Index.html
応答 :
Nuget パッケージがインストールされています:
@marfarma の更新
私のapp.configファイルには、ServiceStackに関連するものは何もありません...
Program.cs :
構成方法:
更新 2:
1.) html と csv を削除する上記のプラグイン セクションを削除しました
2.) パッケージ マネージャー (nuget) で次を実行します。
まだハンドラが見つかりません。
marfarma が指摘したこの質問 ( ServiceStack: No /swagger-ui/index.html ) のアドバイスは、「swagger-ui」html と javascript が存在しない可能性があることを示唆しています。私はそうします。
自己ホスト型サービス スタックは指定されたルートのみを「処理」しているようです。自己ホスト型サービスに Swagger html と JavaScript を配信するように依頼すると、上記の「リクエストのハンドラーが見つかりません」というエラーが表示されます。
自己ホスト型サービスで /resources アドレスにアクセスすると、予想されるページとデータが表示されます (swagger プラグインが適切に機能していることを示唆しています)。 ' 私のサービスによって)、機能するリソース URL を提供すると、「サーバーから読み取ることができません。適切なアクセス制御元の設定がない可能性があります。」というメッセージが表示されますが、これは CORS の問題のようですが、 「サービスでcorsを有効にしました(Swagger UIコードの問題のようです)、swagger-uiはセルフホストサービスに(GETまたはPOSTではなく)「OPTIONS」として送信されたリクエストを送信し、オプションリクエストは失敗します:(
c# - 自己ホスト型 ServiceStack サービスで Swagger が機能しない
この URL のコード例に従います。
https://github.com/ServiceStack/ServiceStack/wiki/セルフホスティング
空のソリューションを作成し、上記の C# コードを「program.cs」に貼り付け、次の nuget コマンドを実行して、必要なライブラリとコード ファイルをインポートしました。
サービスは正常に実行され、swagger メタデータは正しく配信されますが、アクセスしようとすると'Handler not found'/swagger-ui/index.html
というエラーが表示されます。
Dropbox 経由で基本的なサンプル コードを共有しました。
ServiceStackSelfhosted.zip (2.5 MB)
ServiceStackSelfhosted_stripped.zip (8 Kb ですが、nuget コマンドを実行する必要があります)
servicestack - ServiceStack + Swagger-UI [Api] 属性の使用法
私はばかげているに違いありませんが、ServiceStack の SwaggerFeatureに対して [Api] 属性を実際に使用するとどうなるかわかりません。
[Api] にタグを付けなくても、API が Swagger に表示されるかどうかに影響しないようで、[Api("Service Description")] のように使用するとどこにもレンダリングされた説明が見つかりません。
私の使用法は次のようなものです:
Swagger-UI では、展開すると次のように結果がページに表示されます。
mule - Mule で RESTful サービスを文書化するための Swagger の使用
RESTful API の文書化に swagger を使用したいと考えています。ジャージー クラスは、ミュール フローから消費されます。私のAPIを文書化するためにswaggerを使用するには、ここに記載されているようにサーブレット構成を使用する必要があります- https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart
Jersey クラスはミュールにデプロイされるため、web.XML はありません。
Mule で Swagger を構成する方法を知っている場合は、その方法を教えてください。ご意見やご提案をいただき、誠にありがとうございます。
rest - 単純なオブジェクトを持つ配列の Swagger でモデルを記述する方法は?
文書化するRESTサービスがあり、そのうちのいくつかは次のような単純な配列を受け入れます:
これを Swagger モデル セクションでどのように説明すればよいですか? 次のような「名前付き配列」しか作成できません
しかし、それは次のようなデータを説明しています: