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

* シナリオ： *

C# Visual Studio 2012 で作成した Web API サービス アプリケーションを持っています。この Web サービスには、Web API ヘルプ ページの既定のプロジェクトを含む "Areas" フォルダーがあります。

* 問題： *

必要に応じて、Web Api ヘルプ ページを読み取ることができるユーザーを認証および承認するための手動入力を実装する必要があります。ただし、Web サービスではありません。

これまでのところ、アカウント コントローラーを作成し、プロシージャにログインし、データベースからロールを取得するなどを行ってき
ました。私が持っているglobal.asaxはメインプロジェクトからのもので、Web APIヘルプページには彼自身のものはありません。

* 質問 * Web API ヘルプ ページでのみAuthorization 属性を使用するために、メイン サービスに影響を与えずにApplication_PostAuthenticateRequest
メソッド を記述するにはどうすればよいですか?

よろしくお願いいたします。

Web API ヘルプ ページに、同じメソッドを参照する次のような異なる親を持つエントリが繰り返し表示されます。

GET api/{apiVersion}/v1/Products - すべての製品を取得します

...

GET api/v1/Products - すべての製品を取得します

...

次のようなルーティングを含む Web API ページがあります。

このルーティングにより「v1」がオプションになると思っていたので、上記の派生ドキュメントは想定されていません。

(サイドバー: に行くことapi/productsは確かに機能しないので、これの何が問題なのかわかりません。何が欠けているのでしょうか?)

本当の問題は、私が思ったように Web API ヘルプ ページがルートを正しく読み取っていないことでv1あり{apiVersion} 、両方が同じアクションに表示されるべきではないようです。 ここで何が欠けていますか？

ここに示すようなヘルプ ページを追加した C# .Net 4.5 Web Api アプリケーションがあります。

開発者が Visual Studio で Web Api アプリケーションを起動すると、ヘルプ ページが表示されるようにしたいと考えています。

プロジェクトのプロパティの設定ではなく、ルーティング (WebApiConfig.cs または Global.asax.cs への変更など) を使用してこれを実現したいと考えています。

WebApiConfig.cs ファイルで、次を追加しようとしました-

それはうまくいきませんでした。これを機能させる方法を知っている人はいますか？ありがとう。

私は Web API 2 を使用していますが、既存の API 呼び出しが既にプルアップされているようですが、私が持っている各領域のすべての呼び出しが複製されています。たとえば、3 つの領域があり、そのうちの 1 つに次のような API 呼び出しがあるとします。

3 つの領域がある場合、Web API ヘルプ ページには次のように表示されます。

GET area1/api/MyAPIController/GetStringList/{id}

GET area2/api/MyAPIController/GetStringList/{id}

GET area3/api/MyAPIController/GetStringList/{id}

MyAPIController は「area2」にのみ存在します。これが 3 回表示されるのはなぜですか?どうすれば修正できますか? それが役立つ場合、area2の私のエリア登録は次のとおりです。

1 つのソリューションに 2 つのプロジェクトがあるとしましょう

• WebApi: すべての API サービスにアクセス ポイントを提供する WebApi プロジェクト
• コア: システム モデルを含むビジネス ロジックがここで定義されるライブラリ プロジェクト。

WebApi リクエストごとに、ModelState を使用してモデルが有効かどうかを確認し、Core ライブラリで定義されたビジネス モデルにリクエストを渡して結果を取得します。

自動 API ドキュメントが欲しかったので、XML ドキュメントを生成するように WebApi プロジェクトを構成しました。HelpPage モジュールは、Core.dll で定義されたモデルに関しては空白のままであることを除いて、期待どおりに完全に機能しました。

HelpPage モジュールが WebApi プロジェクト外の XML ドキュメントを「認識」できる回避策があるのだろうか?

API ヘルプ ページのドキュメントを必要とするプロジェクトに取り組んでいます。ページはすでに作成されており、情報を挿入する準備ができています。しかし、私はいくつかの問題があります:

1. 私はこれに非常に慣れていないため、プロジェクトをナビゲートする際にいくつかの問題があります。

2. 次のように、Controller ファイル内にある XML コメントを直接参照したいと考えています。

   /li>

WebApiConfig.cs ファイルの HTTP ルート コードは次のようになります。

しかし、Web ヘルプ ページにコメントを投稿する方法がわかりません。パラメータ ID が使用されている多くの例を見てきましたが、ID がないように見えます。また、ヘルプ ページには ID 以外のすべてが表示されるため、パラメータ ID の検索方法や作成方法がわかりません。たとえば、XMLDocument.xmlファイルを作成して、そこにすべてのコメントを入れる必要がありますか?

属性を使用して Web API ヘルプ ページを生成するためのサンプルを提供する方法はありますか? /Areas/HelpPage/... にアクセスしてサンプルを提供できることはわかっていますが、すべてのサンプルをコードと共に 1 か所にまとめたいと考えています。

これらの行に沿ったもの：

私は ASP.NET Web API を使用しており、API のドキュメントを便利に自動的に生成しますが、意味をなさないものもあります。

以下のスクリーンショットを例に取ります。

これはGETID によるユーザーへのエンドポイントであり、このセクションでは、コントローラー アクションに注釈Resource Descriptionがあるため、ユーザー モデルのプロパティを示すテーブルを示しています。[ResponseType(typeof(User))]

まず、実際のコントローラー アクションでは、Password機密情報を公開しないように、結果をユーザーに表示する前にプロパティを削除しています。そのため、セクションに示されている表Resource Descriptionは正しくありません。API が返さないフィールドを返しているということです。

次に、列の下に、モデルAdditional Informationに沿った検証ルールが表示されます。便利ですが、このエンドポイントはユーザー用ではなくユーザーUser用であるため、この場合はまったく関係ありません。GETPOST

それで、私の質問は、このResource Descriptionテーブルをカスタマイズして、返されるフィールドを自分で指定し、EF 検証を非表示にするにはどうすればよいですか?

現在、コントローラーのアクションに次のようにコメントしています。

///また、プロジェクトをビルドするときにこれらのコメントからビルドされる XML ファイルからドキュメントを読み取るようにヘルプ ページを構成しました。

ありがとう！