問題タブ [asp.net-web-api-helppages]
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-api - ASP.NET Web API ヘルプ ページでは、F# レコード タイプに関する不完全なドキュメントが生成されます
ASP.NET Web API ヘルプ ページ プロジェクトでは、Web API コントローラー アクションのパラメーターまたは結果の型として使用される F# レコード型の完全なドキュメントは作成されていません。メンバーはリストされますが、XML コメント内の要約情報は生成されたドキュメントには表示されません。これを修正するにはどうすればよいですか?
例
次の F# レコード タイプが、Web API アクション メソッドのパラメーターまたは結果タイプとして使用されているとします。
期待される出力
このタイプの生成されたヘルプ ページ ドキュメントには、このメンバーの説明列に概要情報が含まれている必要があります。
実際の出力
実際に見られるのは、要約情報がまったくないことです。
仕様
この問題は、次の特定のテクノロジに関連して発生します。
- Microsoft ASP.NET Web API ヘルプ ページ v5.1.1;
- Visual Studio Professional 2013 (アップデート 1); と
- F# 3.1 コンパイラ。
自己回答にもかかわらず、私が現在持っているものは実際にはマスタードをカットしていないため、フロアはより良い解決策に対して広く開かれています.
asp.net-web-api - Web API ヘルプ ページ - ユーザー固有の応答タイプ
ユーザーに基づいて異なる応答を出力する API を開発しています。現在、ResponseType 属性を使用して、返される応答のタイプを記述していますが、これにより、1 つのタイプの応答しか指定できず、ユーザー。
ヘルプ ページをカスタマイズして、ユーザーが受け取る応答の種類を表示する方法はありますか?
c# - XML ドキュメント タグは Web API 2 ヘルプ ページで処理されませんか?
<see cref="">API の XML ドキュメント タグでタグを使用しようとしていますが、ヘルプ ページで空白になります。
したがって、説明については、次のように言いたいと思います。
「関連付けられたItemの値を取得または設定します。」
Itemは、API 内の別のオブジェクトへのリンクです。
代わりに、私は得ています：
関連する の値を取得または設定します。
そのため、<see cref="">タグは無視されています。宣言が間違っていた場合に備えて、こちらの例を使用してみましたが、それもうまくいきませんでした。
他の誰かがこれに問題を抱えていますか? 新しい Web API 2 ヘルプ ページでは、XML ドキュメント タグはどのレベルまでサポートされていますか? これを手動でサポートを追加できるかどうかを知っている人はいますか?
c# - API モデルの応答モデルの文書化
API を文書化していますが、作成した ViewModel に応答形式をリンクする方法を考えています。ViewModel には、ユーザーに閲覧してもらいたい注釈があります。問題は、コントローラーが実際のモデル自体ではなくHttpResponseMessageを返すことです。そのため、WebAPI ヘルプ ページでは、これについての説明を省略しています。
HelpPageConfig.cs に以下を追加しました。
これを回避し、APIExplorer を使用してヘルプ ページにリンクを作成するにはどうすればよいですか。または、これは手動で行う必要がありますか?
コントローラーの例。