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

API ヘルプ ページに問題があります。API のルートを変更するまでは問題なく動作します。

この例を見てみましょう。ユーザーの予約アクションを制御するための予約 API があります。

そして、私は予約を取得するためのルートを持っています

したがって、生成されたページには、次のように、予約用のドキュメントが 1 つしかありません。

POST アクションに関するドキュメントはありません。どうしてか分かりません。どうもありがとう ！

私は C# で Web Api サービスを作成し、MVC プロジェクトを含む "Areas" フォルダーを追加するヘル​​プ ページを作成しました。

ルーティングのコントローラーを変更して、サービス/ヘルプページをデフォルトページにしようとしましたが、もちろん、「ヘルプ」は Web Api サービスのコントローラーではないため、できませんでした。

誰かが私のサービスにアクセスしたときに、デフォルトでヘルプ ページにリダイレクトするにはどうすればよいですか?

よろしくお願いいたします。

SDammann パッケージ以外のバージョン管理をサポートする Web API ヘルプ ページのパッケージまたは拡張機能があるかどうか疑問に思っています。

私はこのようなものが欲しいです

次に、Api ヘルプ ページに、サポートされている最小バージョンが表示されます。

API のバージョンごとに個別のヘルプ ページを作成したいと考えています。たとえば、ユーザーは /help?v=1 にアクセスしてバージョン 1.0 のルートを表示し、/help?v=2 にアクセスしてバージョン 2.0 のルートを表示できます。

を使用して、定義されたバージョンのルートのみを返すプロパティをSDammann.WebApi.Versioningに追加し、バージョンを引数としてコンストラクターに追加しました。それから私はこれを試しました：VersionVersionedApiExplorer

しかし、これにより次のエラーが発生します。

構成を機能させるために、サービスのインスタンスを 1 つだけ追加しconfig.Services.Replace(typeof(IApiExplorer), new VersionedApiExplorer(GlobalConfiguration.Configuration, "1"));て、ヘルプ コントローラーをテストできるようにしました。次に、これを試しました：

これにより、上記で受け取ったのと同じエラーが発生します。通常は使用することthis.Configuration.Services.GetApiExplorer()はわかっていますが、それを使用して の適切なインスタンスを取得する方法がわかりませんVersionedApiExplorer。コントローラーで適切なものを直接インスタンス化できることはわかっていApiExplorerますが、可能であればそれを構成ファイルに保持したいと思います。

だから私は2つの質問があります：

1. VersionedApiExplorerタイプの 2 つのサービスを構成オブジェクトに追加するにはどうすればよいですか?
2. ヘルプ コントローラーで適切なサービスを取得するにはどうすればよいですか?

それとも、同じ目標を達成するために取ることができるまったく異なるアプローチはありますか?

ありがとうございました！

ASP.NET WEB API を使用して開発された残りの API があります。ドキュメントを作成するために、ヘルプ ページの nuget パッケージを使用しました。私が遭遇した1つの問題は次のとおりです。私のモデル オブジェクトには、xml ドキュメント コメントがあり、モデルの各メンバーのヘルプ ページの説明になります。説明の特定の部分を新しい行に入れたいのですが、コメント内のすべてが 1 つの段落になっています。コメントを追加しようとし<br/>ましたが、役に立ちませんでした。これを達成する方法を知っている人はいますか？

Web API ヘルプ ページを使用していますが、他のメソッドへのリンクを含めたいと考えています。XML ドキュメント タグは Web API 2 ヘルプ ページで処理されませんか? <see cref='...'> の使用はサポートされていません。

ドキュメントに独自の <a href='...'> リンクを記述し、Web Api ヘルプ ページで説明されている方法を使用するよりも優れたオプションはありますか?これらの <a> タグを取得するには、xml ドキュメントで html をエスケープしないでください。ヘルプに出力しますか? 将来の変化に対して非常に脆いようです。

私が考えることができる唯一の代替手段は、API エクスプローラーを強制的に 2 回実行することです。1 回目はすべての異なるルートとそれに対応するヘルプ ページの URL をキャッシュし、2 回目は実際にドキュメントを生成します。しかし、これをどこに接続すればよいかわかりません (または、それが可能かどうかもわかりません)。

Web API のヘルプ ページに [なし] 以外の [リソースの説明] を表示する方法がわかりません。IHttpActionResult がリンクされており、「なし」になっています。その後。config.SetActualResponseType(typeof(ComplexType), "Controller", "Action");HelpPageConfig.csに追加することで、サンプルが機能するようになりました。私のコントローラーは次のようになります。

HelpPageConfig.cs または他の場所に何が欠けているのかわかりません。新鮮な目が何かを捉えるかもしれません。助けてくれてありがとう！

API ヘルプ ページに multipart/form データ パラメータを追加するのを手伝ってください。

私はMicrosoft.AspNet.WebApi.HelpPage.VB 5.2.2を使用しています。

APIヘルプページに、CustomerName、fdStreet1、fdStreet2のパラメータ情報を追加したいと考えています。これどうやってするの？

これが私がこれまでに持っているものです。