問題タブ [swashbuckle]
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.
asp.net-web-api2 - スワッシュバックルを使用した Web API ドキュメント
現在、従来の WCF SOAP ベースのサービスから切り替えて、製品用の WebApi サービスの作成を開始しようとしています。私たちが抱えている課題は、API ドキュメントを提供する方法です。SwaggerUi/swash バックルに出会いました。制限の 1 つは、IIS ではなく Windows サービスで WebApi サービスをホストしたくないということです。私は Web Api を初めて使用するので、間違った方法で行っている可能性があります。
テストのために、コンソール アプリケーションで Web API をホストしています。HttpClient を使用して Web API で Get メソッドを呼び出すことはできますが、Web ブラウザーに URL を入力すると同じメソッドにアクセスできません (自己ホスト型 Web API ではこれは正常ですか?)。
そこで、Swashbuckle.core nuget パッケージをインストールし、Startup クラス (Owin セルフホスト) に次のコードを含めました。
http://localhost:5000/swagger/ui/indexの場所を参照すると 、IE で「ページを表示できません」というメッセージが表示されます。クロムについても同様です。ドキュメントを自動的に取得するために、コンソール/Windows サービス アプリケーションで WebApi をホストするときに何か特別なことをする必要がありますか?
(プロジェクトの Xml ドキュメントを有効にしました)
テストプロジェクトを添付しました。以下のリンクに従ってください。
よろしく、
ナス
jquery - ajax 呼び出しの beforeSend イベントをキャッチするにはどうすればよいですか?
どこで開始されたかに関係なく、ページ上のすべての ajax 呼び出しに対して $.ajax beforeSend イベントをキャッチすることは可能ですか?
具体的には、Swagger UI / Swashbuckle を使用しており、ページ上の JS コードを直接変更することはできませんが、SwaggerConfig.cs の .EnableSwaggerUI 呼び出しで InjectJavaScript 呼び出しを使用してスクリプトを挿入できます。Swagger データは私の制御範囲外であり、oauth 設定を表示するように正しく形成されていないため、ユーザーが API キーを入力してヘッダーに配置できるようにする必要があります。
以下を含む複数の反復を試しました。
と
と
すべてゼロの成功です。おそらく私はコードをあまりにも長く見つめていて、それは明らかですが、関数を呼び出すことができません.
c# - Swashbuckle swagger RootUrl/swagger/docs にアクセスしても出力が得られない
Web API 2 プロジェクトがあります。これは、owin を使用して自己ホストされるように構成されています。global.asax ファイルはありません。Web API のヘルプ ページが必要で、swaschbuckle を使用しています。しかし、rooturl/swagger/docs には出力がありません。
こちらの「 https://github.com/domaindrivendev/Swashbuckle/issues/196 」の指示に従いましたが、まだ機能していません。以下は私の設定コードです
コードに間違いがあれば指摘してください。
asp.net - ASP.NET Web Api の Swashbuckle が入れ子になったコントローラーによって混乱する
私の ASP.NET Web Api (ASP.NET 4 MVC 5) アプリケーションでは、次のように構成された 2 つのルートがあります。
UsersController
これらは、最初のルートに一致する「最上位」と、2 番目のルートに一致する「子」LockController
(Users
フォルダ内) があるという点で、実際には非常にうまく機能します。
アプリケーションにSwashbuckle 5 ( .net 用のSwagger ) を追加したので、Swagger は混乱して、実装した各メソッドの両方のルートを表示します。例えば:
そのため、Swagger はLockController
を最上位コントローラーと子コントローラーの両方として認識します。
特定のコントローラーがトップレベルまたは子であることを Swagger に伝えるにはどうすればよいですか?
さらに、たとえば、ロック リソースへのパスがSwagger が現在表示しているもの/api/users/{id}/lock
とは異なる ことを Swagger に認識させることはできますか?/api/{parentController}/{parentId}/lock
asp.net-web-api2 - JSON を使用した Swagger/Swashbuckle ドキュメント POST
Swashbuckle または Swagger に挑戦しています。問題が Swagger にあるのか Swashbuckle にあるのかわかりません。私は、URIパラメーターとしてのパラメーターと、リクエストの本文からのコンテンツの読み取りの両方を実装したWeb API呼び出しを持っています。
1つは次のように実装されています。
もう 1 つは次のように実装されます。
どちらも同じリクエストオブジェクトなどを使用しています。ApplicationRequest
クラスには列挙型が含まれていPurpose
ます。最初のサービスでは、Swagger ドキュメントが美しく作成され、次のApplication
ように型の各プロパティに関する優れたドキュメントが作成されます。
ただし、標準の HTTP 本文 POST を使用する 2 番目の方法では、良い JSON の例が生成されますが、列挙型で許容される値は生成されません。これは Swashbuckle や Swagger の欠陥ですか、それともツールの使用方法に関する私の知識不足ですか?
これは、2 番目のメソッドから生成されるものです。
ご覧のとおり、「目的」には最初の可能な列挙値のみが含まれています。また、コンテキストの説明 (ApplicationRequest
表示属性として提供される) はどこにも表示されません。