Asp.net和Swagger仅显示特定的端点
创始人
2024-09-18 22:02:09
0

要在Asp.net中仅显示特定的端点,可以使用Swagger来定义和配置API文档,并使用特性来控制端点的显示。

首先,确保已经安装了以下NuGet包:

  • Swashbuckle.AspNetCore:用于集成Swagger到Asp.net项目中。

然后,在Startup.cs文件中的ConfigureServices方法中添加以下代码来配置Swagger:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});

接下来,在Configure方法中添加以下代码以启用Swagger中间件:

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

现在,可以使用特性来控制端点的显示。在需要隐藏的端点上添加[ApiExplorerSettings(IgnoreApi = true)]特性,如下所示:

[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    [HttpGet]
    [ApiExplorerSettings(IgnoreApi = true)]
    public IActionResult Get()
    {
        // ...
    }

    [HttpPost]
    public IActionResult Post()
    {
        // ...
    }
}

在上面的示例中,Get方法被标记为忽略Api,因此在Swagger文档中不会显示该端点。

重新运行应用程序并访问Swagger UI,您将只看到标记为未被忽略的端点。

请注意,Swagger是基于注释和特性生成文档的,所以确保在控制器和操作方法上使用适当的特性和注释。

相关内容

热门资讯

安装apache-beam==... 出现此错误可能是因为用户的Python版本太低,而apache-beam==2.34.0需要更高的P...
避免在粘贴双引号时向VS 20... 在粘贴双引号时向VS 2022添加反斜杠的问题通常是由于编辑器的自动转义功能引起的。为了避免这个问题...
Android Recycle... 要在Android RecyclerView中实现滑动卡片效果,可以按照以下步骤进行操作:首先,在项...
omi系统和安卓系统哪个好,揭... OMI系统和安卓系统哪个好?这个问题就像是在问“苹果和橘子哪个更甜”,每个人都有自己的答案。今天,我...
原生ios和安卓系统,原生对比... 亲爱的读者们,你是否曾好奇过,为什么你的iPhone和安卓手机在操作体验上有着天壤之别?今天,就让我...
Android - 无法确定任... 这个错误通常发生在Android项目中,表示编译Debug版本的Java代码时出现了依赖关系问题。下...
Android - NDK 预... 在Android NDK的构建过程中,LOCAL_SRC_FILES只能包含一个项目。如果需要在ND...
Akka生成Actor问题 在Akka框架中,可以使用ActorSystem对象生成Actor。但是,当我们在Actor类中尝试...
Agora-RTC-React... 出现这个错误原因是因为在 React 组件中使用,import AgoraRTC from “ago...
Alertmanager在pr... 首先,在Prometheus配置文件中,确保Alertmanager URL已正确配置。例如:ale...