問題タブ [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.
c# - WebAPI のドキュメント リクエストおよびレスポンス ヘッダー
各コントローラーの要求と応答ヘッダーを (グローバルに) 渡す WebAPI サービスを開発しました。WebAPI HelpController は、HttpResponseMessage と Requests を通じて、これらのドキュメントをサポートしていますか?
リクエストヘッダーの例;
コンテンツ タイプ: アプリケーション/xml; 文字セット=utf-8
応答ヘッダーの例。
X-Rate-Limit-Remaining: 1000
X-Rate-Limit-Limit: 1000
c# - 生成されたクラス プロパティにコメントを適切に追加する方法は?
Oracle データベースから EF によって生成されたいくつかのクラスがあります。これらのクラスは、ヘルプ ページを備えた安らかな Web API を構築するために使用されます。生成されたクラスのプロパティにコメントを追加するにはどうすればよいでしょうか。生成されたこれらのクラス ファイルを編集できますが、それらを再マップする必要がある場合、それらはなくなります。
生成されたクラスの DTO クラスを作成してAutoMapperを使用しようとしましたが、DTO を作成するクラスが非常に多いため、すぐに手に負えなくなります。さらに悪いことに、派生クラスが 2 つのプロパティになり、ヘルプが作成されます。あまり役に立たないページ。
C# でクラスのプロパティを再定義できることを願っていますが、それが不可能であることはわかっています。生成されたクラスにコメントを追加する最も簡単な方法は何でしょうか。
c# - 複合型に関する説明の文書化
私の API 内で、さまざまなフィールドの説明を文書化しようとしていますが、どの属性も機能していないようです。この機能は、最近 WebAPI 5.1 (WebAPI.HelpPage 5.1.2 を実行) 内に実装されたはずです。
ASP.Net Web API ヘルプ ページ: ドキュメント モデル データ注釈 - 作業項目 877
私は両方の応答モデルを文書化しようとしています:
そして個々のフィールド/プロパティ
XML コメント、DataMember、および Display 属性を組み合わせて試してみましたが、何も検出されないようです。
これは私の Areas/HelpPage/App_Start/HelpPageConfig.cs のサンプルです
2014 年 10 月 6 日更新: 私のクラス定義は別のライブラリに保存されます。ここで矛盾に気づきました。メイン API とクラス定義ライブラリは、別々の XML ファイルを生成していました。
API プロジェクト
定義プロジェクト
定義を同じ XML プロジェクトに書き込むことで、これを修正しようとしました。ただし、これは機能せず、クラス定義エントリは追加されません。
c# - ASP.NET Web API ヘルプ ページはジェネリック型コントローラーを処理できません
ASP.NET Web API HelpPages について質問があります。
通常、HelpPages は XMLDocumentation サンプル コードによって WebAPI を生成できます。
これは、次のように正常に生成できます。
しかし、汎用ベース コントローラを使用すると、API ドキュメントは生成されません。
サンプル：
2 番目のセクションのコードを使用すると、HelpPages は API ドキュメントを生成できますが、API 注釈は生成しません。私の 2 つの例の違いは、ジェネリック型を使用する 2 番目のセクション コードだけです。
メソッドDo()では、最初と比較して注釈が表示されません
これらの問題を解決する解決策はありますか?
c# - WebAPI ヘルプ ページ DTD または XSD スキーマ ファイルの生成
WebAPI Help Pagesから WebAPI プロジェクトの DTD または XSD ファイルを作成することは可能ですか? 私は WebAPI ヘルプ ページを使用して要求モデルと応答モデルを文書化していますが、より正式な定義文書を作成した後でした。
asp.net-web-api2 - 外部ライブラリ クラスの Web API にヘルプを追加する方法
おはようございます、
2 つのプロジェクトで構成されるソリューションがあります。1 つは、他のプロジェクトで使用される共通のクラスを含むクラス ライブラリです。もう 1 つは WebAPI 2.1 プロジェクトです。
自動ヘルプ ページ ジェネレーターを使用して API のヘルプ ファイルを生成していますが、Common プロジェクトのクラスを参照するときに、概要が使用されていないことに気付きました。
これを行う方法はありますか？オンラインで検索しましたが、これに対する解決策が見つかりません。また、Common プロジェクトにヘルプ ページ ジェネレータをインストールしようとしましたが、うまくいきませんでした。
asp.net-web-api2 - テンプレート クラスを含む Web API ヘルプ ページ
テンプレート クラスを返す ASP.NET Web API がありますが、戻り値の型に関するドキュメントを正しく提供する Web API ヘルプ ページを取得できません。
次の Model クラスがあるとします。
私のAPIアクションは次のようになります
結果の Web API ヘルプ ページでは、Get アクションが を返すことを宣言し、MyTypeOfFooMyType の XML ドキュメントは提供せず、含まれるパラメーターをリストするだけです。MyTypeOfFooと同じことを理解していないからでしょうMyType<Foo>。この問題に対する既知の解決策はありますか?
アップデート
疑似クラスを作成して代わりに返すことも機能しません。例えば
上記のコードのドキュメント出力には、継承されたプロパティで使用できるコメントがありません。