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

従来の asp.net エンジンを使用してレンダリングするヘルプ ページを取得できますが、OWIN/katana で Web API サービスをホストするときに同じことを行うにはどうすればよいでしょうか。

無駄に追加しようとしHelpPageConfig.Register(config);ました。class Startup

I am working on customizing the ASP.NET Web API help pages.

I am looking for the best approach to display methods that belong to a controller specified by the URL. My controllers are all prefixed with "ws_".

I have added an entry to my RouteConfig to recognize URLs containing the string "ws_" as follows:

Here is my HelpController. I'm trying to get the WsContext method to strip out methods that do not belong to the controller (i.e. ws_testController) passed via the URL (i.e. mysite.com/ws_test).

I am currently receiving the following error:

No route in the route table matches the supplied values.

開発を開始した数か月前に、手動でAreasフォルダーを削除した Web API プロジェクトがあります。すべてが完了したら、API ヘルプ ページを追加したいのですが、期待どおりに機能しません。

ヘルプページの nuget パッケージをインストールしました。

行のコメントを外しましたHelpPageConfig.cs

Generate documentation file (to App_Data folder)にチェックを入れました

http://localhost:51665/helpを開くと、次のようになります: (メソッドは表示されません)

何が間違っている可能性がありますか？新しいプロジェクトを最初から開始すると、すべてが正常に機能します。

ヘッダー Content-type を渡すサーバーで 1 つの API 呼び出しにヒットしました。

Web API ヘルプ ページのドキュメントでは、Web API 呼び出しが行われたときにこのヘッダーが渡されることを示したいと考えています。

メソッドのドキュメントのコードの下に置きます。

しかし、このxmlドキュメントでヘッダーを渡す方法は?

FluentValidationを WebAPI で使用して、プロパティに実装されているルールを表示しようとしています。

API のヘルプ ページを生成する Microsoft.AspNet.WebApi.HelpPage アセンブリを使用しています。検証ルールを列挙して、必要な属性や長さなどの属性をヘルプ ページに表示できるようにしたいと考えています。

以前は、次のようなカスタム属性に対してこれを行っていました。

これにより、ヘルプ ページの追加情報セクションに必要なテキストが追加されます。FluentValidationを使用する場合、必要な型が設定されなくなりました。それは今のようなものですRuleFor(x => x.MyProperty).NotEmpty();

役立つ場合は、注釈を文書化するコードを以下に示します。

この GenerateAnnotations ルーチンを呼び出すときに、プロパティを確認し、割り当てられたすべての流暢な属性を取得してテキストを追加するロジックを追加したいと考えています。

FluentValidation.Internal.PropertyRulesを何らかの方法で使用して、属性をエレガントに列挙することはできますか?

Microsoft Web API コントローラー クラス (v2.1) を使用し、各クラスとメソッドの先頭で XML を使用してドキュメントを自動的に生成する Web サービスを作成しています。生成されたドキュメントには、各クラスとメソッドをリストしたホームページがあり、詳細を表示するためのリンクがあります。

残念ながら、このホーム (またはインデックス) ページにはクラスがランダムな順序で表示されているため、必要なクラスを見つけるのが難しくなっています。

それらをアルファベット順に表示する方法はありますか?

次のようなルートを持つ複数のコントローラーエンドポイントがあります。

それらはすべて、次のようなメソッド シグネチャを持っています (アクセス修飾子と戻り値の型は省略されています)。

カスタム モデル バインダーを使用すると、次のようにエンドポイントに投稿できます。

これはうまくいきます！ただし、これらのメソッドはすべて、ヘルプ ページのドキュメント生成プロセスでは無視されます。

次のように modelbinder 属性を削除すると:

それでもうまくいきません。[FromUri]パラメータに追加し{objectIds}てルート属性から削除した場合にのみ機能します。

しかし、これは次のように不要な uri を生成します。

ヘルプ ページのドキュメント プロセスでエンドポイントを認識するにはどうすればよいですか?