Web API コントローラーをセットアップしました ヘルプ ページは動作していますが、特定の API コントローラーをヘルプ ページに表示したくありません
ヘルプ ページに API コントローラーが表示されないようにするにはどうすればよいですか?
乾杯
Web API コントローラーをセットアップしました ヘルプ ページは動作していますが、特定の API コントローラーをヘルプ ページに表示したくありません
ヘルプ ページに API コントローラーが表示されないようにするにはどうすればよいですか?
乾杯
クラスの前、またはコントロール メソッドの前に以下を使用できます。
using System.Web.Http.Description;
//you have to use above namespace to use the code below.
[ApiExplorerSettings(IgnoreApi = true)]
クラスの前にそれを使用すると、コントローラ クラス全体が無視されます。したがって、特定のコントローラーの見出しは見つかりません。
コントローラー メソッドの前にこれを使用すると、そのコントローラーのみが無視され、ヘルプ ページに表示されません。
次の属性と設定でコントローラーを装飾できます。
[ApiExplorerSettings(IgnoreApi = true)]
すべてのコントローラー (通常は多数あります) を無効にする場合は、それらのコントローラーのベースとして新しいコントローラーを作成します。
/// <summary>
/// Base api controller for all controllers
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class BaseApiController : ApiController
{...
次に、新しいベース コントローラーを現在のコントローラーの親として配置します。
public class MyController: BaseController
ヘルプページではすべてのコントローラが無効になります