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

NuGet からパッケージをインストールし、HelpPageConfig.cs- の行のコメントを外しました。

Properties->Build->XML ドキュメント ファイルの下に同じファイルを設定しました。 Application_Start メソッドの下のすべての領域の登録を呼び出す新しい Global.asax.cs ファイルを追加しました。

一部のコントローラーの概要を追加しました。

Web ページを実行して「/help」に移動すると、表示されるのは

ASP.NET Web API ヘルプ ページ

序章

API の一般的な説明をここに入力してください。

その後、空のページ...

私はそれをデバッグしようとしましたが、HelpController.cs で:

ApiDescriptions がありません。

私は何が欠けていますか？どんな助けにも感謝します！

私は基本APIコントローラーを持っています：

ベースからメソッド GetByYear を継承した子:

ヘルプページを使用して自動ドキュメントを作成しています。その結果、次のようになります。

2つの方法の説明を取得したいと思います。
オーバーライドせずに、子クラスのメソッド GET への XML コメントを取得するにはどうすればよいですか?
または、子クラスにコピーする必要がありますか？

HouseControllerで使用する<inheritdoc />と、上記と同じ結果が得られます。必要でない場合は各メソッドをオーバーライドしたくありません。

別の質問: デフォルトのヘルプ ページで Ghostdoc を使用するにはどうすればよいですか?

プログラムを実行すると、「API の一般的な説明をここに入力してください」としか表示されません。しかし、コンテンツは表示されません。この写真のように: http://i.stack.imgur.com/unBmb.png

私の問題は、このASP.NET Web Api ヘルプ ページにヒントは表示されませんが、解決策はありません。

「既存のプロジェクトにヘルプ ページを追加する」のこのチュートリアルhttp://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pagesに従いました。 「ValuesController」を除いて、すべてが nuGet から自動的に作成されます。

問題はそこにあると思います。

私の値コントローラー:

これに対する解決策、またはどこで問題が発生する可能性があるかについての提案はありますか?

(また、新しい asp.net Web api-project (最初から値コントローラーを含む) を作成しましたが、これは正常に動作します..)

整数のリストであるパラメーターを持つオブジェクトがあります。このオブジェクトが Entity Framework で適切に動作し、SQL に保存されるようにするために、その文字列をシリアル化する計算プロパティがあります。

データベースにはシリアル化されたバージョンが保存され、コード内の整数のリストを操作できるため、これは完全に正常に機能し、私がやりたいことを正確に実行します。シリアル化された文字列には整数のみが含まれるため、問題はありません..

..API ドキュメント ジェネレーターを除きます。Microsoft.AspNet.WebApi.HelpPage を使用して、コード ドキュメントからヘルプ ページのコンテンツを自動的に生成しています。何らかの理由で、これは「サンプル文字列 3」を ObjParametersSerialized の値として挿入しようとしています - これは明らかに機能せず、エラーをスローします。

値としても意味がありませんが、単に typeOf(string) を見ているだけなので、なぜそうしているのか理解できます。

HelpPage ジェネレーターをカスタマイズまたはオーバーライドして、適切な値を提供するにはどうすればよいですか?

新しい Web API の展開に Azure を使用しています。IIS と Azure への展開は初めてです。

Web アプリケーションとして Azure に Web API を追加しましたが、各 API の機能のドキュメントを追加するまでは正常に動作しています。説明を追加した後、HelpPageConfig.cs から以下の行のコメントを外します。

finr はローカルで動作しており、すべての説明を見ることができますが、Azure で公開すると、次のようなエラーが表示されます。

サイト URL : http://mejodo.azurewebsites.net/

パスを変更する必要がありますか?

私のシステムの D:\home\site\wwwroot\App_Data ディレクトリにファイルが既に作成されています。

それを機能させるには、どのような変更を行う必要がありますか?

ASP.NET 5 の作業を始めたばかりです。メソッドのヘルプ ページが必要です。ヘルプ ページを作成する例はほとんど見たことがありませんが、それらのほとんどは MVC 固有のものです。パッケージを確認Microsoft.AspNet.WebApi.HelpPageしました。ヘルプ ページのエリアが作成されますが、MVC パターンは使用していません。

このエリアアプローチ以外のヘルプページを作成するにはどうすればよいですか?

Web API ヘルプ ページのドキュメントを構成しました。

私は他のモデルクラスに継承される以下のクラスを持っています。

IsRejected をシリアル化して応答で利用できるようにしたくないので、IgnoreDataMember 属性で装飾しました。

ResponseBaseを継承したモデルクラスの例。

Web API コントローラーのメソッドを以下に示します。

ここで、Reading オブジェクトのリストであるリクエスト パラメーターのドキュメントとして、Reading のすべてのプロパティと ResponseBase クラス (継承) を一覧表示します。ヘルプ ページのドキュメントに、ErrorReason を Response のみのパラメーターの 1 つとしてリストアップしてほしい。

[ApiExplorerSettings(IgnoreApi = true)]ErrorReason に属性を設定する以外にできる設定はありますか? これを行うと、ErrorReason は要求パラメーターと応答パラメーターの両方で使用できなくなります。Response Parameters リストのみに表示したい。

WebApiヘルプ エリアのあるサービスがあります。セキュリティ上の理由から、このMVCヘルプ エリアをMVC同じソリューション内の別のプロジェクトに移動する必要があります。

どうすればこれを達成できますか？

API情報がファイルで取得されていることは理解していXMLますが、領域とファイルを移動するだけXMLですか?