在发布版本中隐藏 api 端点

Question

我正在开发一个 Asp.net Web api 项目。我最近使用创建了一个文档端点config.Services.GetApiExplorer();

在生产中隐藏此端点并仍然可供我团队中的所有其他开发人员使用的最佳方法是什么？

我能想到的一种方法是使用注册路线

#if debug

routes.MapRoute(
"documentation",
"documentation/help", 
new { controller = "apiexplorer", action
= "Index" }
);

#endif

Answer 1

There is two attribute could hide an API endpoint:

[ApiExplorerSettings(IgnoreApi = true)]
[NonAction]
public async Task<void> PrivateAPI()
{
...
}

But for your case, I probably create a new attribute to check the environment and apply that attribute to your controller method. Inject the 'IHostingEnvironment' class, then use .IsDevelopment() method.