問題タブ [asp.net-web-api-helppages]

ヘルプ ページにメソッドの両方のバージョンが表示されないようにするにはどうすればよいですか?

ご覧のとおり、 のカスタム ルートを設定しました/api/property/search/{finnId}が、クエリ パラメータを使用するルートをヘルプ ページに表示したくありません。これを回避する方法はありますか？ASP.NET Fall 2012 BUILD preview の組み込みのヘルプ ページを使用しています。

ところで、 と表示されていても心配しないでくださいPOST。その後、 に切り替えましたGETが、同じ結果が得られます。

ASP.Net Web Api ヘルプ ページは、パラメーターが要求 Uri または本文にあるかどうかを自動的に判断するようです。QueryString パラメーターであるオプション パラメーターを文書化するにはどうすればよいですか?

たとえば、次のようなRESTful URLがある場合があります

ここで、「relatedToBookId」はオプションの queryString パラメータです。

通常、FromUri または FromBody であるパラメーターは、次のようにコメントに入れられます。

Web API があり、ドキュメントを自動生成するWeb API ヘルプ ページを追加しました。パラメータがリストされているメソッドではうまく機能しますが、次のようなメソッドがあります。

また、私のヘルプ ページでは、プロパティ セクションにコマンド パラメータのみがリストされています。ただし、サンプル リクエスト セクションでは、CreateSessionCommandクラスのすべてのプロパティがリストされています。

パラメーター

名前 | 説明 | 追加情報

リクエスト | ドキュメントはありません。| | リクエスト本文でこのパラメータを定義します。

代わりに、クラスのすべてのプロパティをリストしたいと思いCreateSessionCommandます。これを行う簡単な方法はありますか？

Web API ヘルプ ページ ジェネレーターを使用して API ドキュメントを生成しています。しかし問題は、ヘルプ ページ ジェネレーターが Enum パラメーターを持つメソッドのドキュメントを生成できないことです。これは、オブジェクトおよび動的タイプのパラメーターでも発生します。

これが私の方法です：

そして、ここにドキュメントの生成があります：

しかし、正しい形式は次のとおりです。

API モデルのドキュメントにアクセスすると、パラメーターはありますが、説明がありません。

こんな感じです：

これはヘルプ ページ ジェネレーターのバグですか? ページの例を修正するにはどうすればよいですか?

ApiExplorer にリクエスト サンプルを自動生成させる方法はありますか?

私は使用してみました：

HelpPageConfig.csで、しかし2つの問題が発生しました:

1. 特定のコントローラーとアクションの特定のタイプを定義する必要があり、新しいコントローラー\タイプが追加された場合にコードの追加\変更を必要としない、より一般的なものを探しています。

2. コントローラー/アクションごとに 1 つの型しか使用できないため、要求本文で2 つの複合型を受け取るアクションの完全な要求サンプルを生成できません。

これらの問題を解決/アプローチする方法についてのアイデアはありますか?

http://myserverヘルプ ページにアクセスして、デフォルトのホームページとして取得できるようにしたいので、ゲストが最初にhttp://myserver表示するのはヘルプ ページです。

次のようにデフォルトルートを設定しています。

次に、ヘルプ ページ エリアの登録を次のように設定します。

RouteConfig を に変更すると、次のcontrollerよう"Help"になります。

ビュー「インデックス」またはそのマスターが見つからないか、検索された場所をサポートするビュー エンジンがありません

ヘルプ ページのルートを"{controller}/{action}/{apiId}"AttributeRoutes に変更すると、機能しなくなります。

ASP.NET ヘルプ ページを既定のホーム ページにする簡単な方法はありますか?

I've installed the correct package for Web Api 2

But the help area is not being mapped and is returning 404 (Web Api working fine). I'm using Microsoft.Owin.Host.SystemWeb as the host. Below is my Startup code.

デフォルト (bin\EnterpriseServices.XML) 値でプロジェクト プロパティの「XML ドキュメント ファイル」を有効にするか、App_Start\SwaggerNet.cs の値を編集してください。

MVC4 WebAPI を使用していますが、いくつか質問があります。

1. [パラメーター] ページの「コンテンツ」を定義するにはどうすればよいですか [追加情報] ??
   デフォルトでは、これは「リクエスト本文でこのパラメーターを定義する」と述べています??

2. パラメーター ページ [サンプル]でサンプル データを定義するにはどうすればよいですか??
   たとえば、1 つの文字列値が「COME」または「GO」のいずれかであると仮定すると、デフォルトの「文字列」値を取得する代わりに、ヘルプ ページに記載されている値を取得するにはどうすればよいでしょうか?

3. ヘルプ ページに表示されるように、期待されるヘッダー値や API が生成する可能性のある応答/エラーなどの制約を配置する適切な場所はどこですか?