問題タブ [asp.net-mvc-apiexplorer]

MVC4 WebAPI を使用していますが、いくつか質問があります。

1. [パラメーター] ページの「コンテンツ」を定義するにはどうすればよいですか [追加情報] ??
   デフォルトでは、これは「リクエスト本文でこのパラメーターを定義する」と述べています??

2. パラメーター ページ [サンプル]でサンプル データを定義するにはどうすればよいですか??
   たとえば、1 つの文字列値が「COME」または「GO」のいずれかであると仮定すると、デフォルトの「文字列」値を取得する代わりに、ヘルプ ページに記載されている値を取得するにはどうすればよいでしょうか?

3. ヘルプ ページに表示されるように、期待されるヘッダー値や API が生成する可能性のある応答/エラーなどの制約を配置する適切な場所はどこですか?

Web API 2 (5.0) で Web API ヘルプ ページを使用しています - どちらも最新の Nuget パッケージです。パラメーターであるか、HttpResponseMessage の本文で返されるクラスのプロパティのコメントをヘルプ ドキュメントに表示したいと思います。

たとえば、次のようなコントローラー メソッドがあります。

私が持っている XML コメントを上記の投稿アクションのヘルプ ページに表示したいMyClassType1と考えています。MyClassType2

どこを見ても、これはまだサポートされていないようです。しかし、誰かが ApiExplorer を拡張したり、XmlDocumentationProvider に追加したりして、これを機能させることができたのでしょうか?

生成される XML ファイルにコメントとプロパティが含まれていることがわかっているので、それを手動で解析することができます (すべてのパラメーターと戻り値の型はMyAssemblyName.Models名前空間にあるため、その名前空間で始まるメンバー名. ただし、組み込みの Web API ヘルプ ページにはいくつかのキャッシュ機能があることを知っているので、これを既存の機能に組み込むことを好みます (単に追加するだけです)。

Parameters.cshtml テンプレートを次のように更新することで、パラメーターの種類を表示することができました (1 レイヤーのみ)。

上記のGetFriendlyTypeName()メソッドは、次のように実装されています:リフレクションを使用してジェネリック型の正しいテキスト定義を取得するにはどうすればよいですか?

ただし、これはこれらのクラスからのコメントを取得せず、ネストされた型には役立ちません (たとえば、モデルに複合型のプロパティがある場合、その複合型のプロパティのプロパティは表示されません)。とにかく、型は XML コメントなしでは十分に役に立ちません。

また、これはパラメーターにのみ適用され、HttpResponseMessage の本文に含まれる戻り型には適用されません。ここに示すように実装することで、応答サンプルを機能させることができましResponseTypeAttributeた: Auto generated help pages with return type HttpResponseMessageが、XML コメントを含むプロパティが得られません。リフレクションを使用して、パラメーターの型を再度取得する方法と同様に型を取得できますが、XML コメントを型と一緒にして、入れ子になった複合型を含めたいと思います。

また、サービス呼び出しとは別に、モデル/クラスのドキュメント (型と XML コメントを含むプロパティ) を文書化し、サービス呼び出しに、返される型の名前のみを表示させることも受け入れられると思います (そうすれば、少なくともユーザーは見つけることができます)。そのタイプのドキュメント)。

パラメータまたは戻り値の型のいずれか、できれば両方に対して私がやろうとしていることと同様のことを実装できた人はいますか? または、私を正しい方向に向けるアイデアはありますか?

apiController と angular で複数のレコードを削除する方法は?

私は次のことを試しました。しかし、私は成功しませんでした

API コントローラー:

ajax メソッド:

レコードの削除は正常に機能します。複数のレコードを削除すると、次のエラーが発生します。

WebApi には、HttpResponseMessage を返すメソッドがいくつかあります。応答タイプが不明であるため、次のようなものを使用して HelpPageConfig に登録する必要があります

config.SetActualResponseType(typeof(X), "SomeController", "GetX");

[ActualResponse(typeof(X)]少し乱雑なリスト内のすべてを参照する大きなレジストリ オブジェクトを作成しないように、コントローラーが宣言されているカスタム属性を使用してこれらを登録したいと思います。

SetActualResponseType を自動的に呼び出すことができるように、登録済みのコントローラーとアクション、およびそれらの属性のリストを取得するために構成を調べるにはどうすればよいですか?

Microsoft.AspNet.WebApi.HelpPage を Web API 2 プロジェクトにインストールし、/help ページを正常に出力できます。

しかし、私がうまくいかないように見えることの1つは、別のプロジェクトで参照されているクラスに追加したxmlコメントドキュメントを生成することです。たとえば、私の Web API コントローラーのコメントはすべて正常に表示されます。ただし、Web API プロジェクトで参照されているプロジェクト x には、XML ドキュメントが適用されたクラスがありますが、/help ファイルには表示されません。

HelpPageConfig.cs で参照される Web API xml ドキュメント ファイルを設定できることはわかっています。

ジェネレーターが他の参照プロジェクトからも XML ファイルを取得できるようにするにはどうすればよいですか。これは API エクスプローラー ツールの現在の制限です。

ありがとう

だから私はこの問題を解決しようとたくさんグーグルで検索してきましたが、何も見つからないようです。参照用の写真を参照してください。ただし、本文パラメーターの [説明] フィールドに入力しようとしています。これを行う最善の方法は何ですか？

正常に動作している [FromBody] を使用して、MVC ベースの Web API にいくつかの文字列を投稿しています。データベースにデータを追加しています。私のコントローラーのアクションメソッドのタイプは HttpResponseMessage で、この応答を返しています

しかし、成功ではなくエラーイベントが発生しています。

これがajax呼び出しです。

この問題を解決するために何か提案してください。