Asp.net和Swagger仅显示特定的端点
创始人
2024-09-18 22:00:32
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是基于注释和特性生成文档的,所以确保在控制器和操作方法上使用适当的特性和注释。

相关内容

热门资讯

突发!哈糖大菠萝怎么挂,新众亿... 突发!哈糖大菠萝怎么挂,新众亿辅助,其实是有辅助方法(哔哩哔哩)1、用户打开应用后不用登录就可以直接...
今年以来!wpk德州局透视,潮... 今年以来!wpk德州局透视,潮汕掌上娱乐脚本,都是是真的有辅助app(哔哩哔哩)1、很好的工具软件,...
无独有偶!werplan有挂吗... 无独有偶!werplan有挂吗,皮皮游戏辅助平台,确实真的有辅助教程(哔哩哔哩)皮皮游戏辅助平台能透...
今年以来!hhpoker德州牛... 今年以来!hhpoker德州牛仔视频,新上游拼十辅助,真是是真的有辅助工具(哔哩哔哩)1、新上游拼十...
在玩家背景下!hhpoker免... 在玩家背景下!hhpoker免费透视脚本,潮汕激k传送屋辅助器,总是是有辅助插件(哔哩哔哩)1、全新...
据报道!来玩app破解版,so... 据报道!来玩app破解版,sohoo竞技联盟辅助,一贯存在有辅助神器(哔哩哔哩)暗藏猫腻,小编详细说...
随着!德州来玩辅助器,微信边锋... 随着!德州来玩辅助器,微信边锋辅助软件,切实真的是有辅助插件(哔哩哔哩)微信边锋辅助软件能透视中分为...
最新消息!aapoker插件,... 最新消息!aapoker插件,小唐家乐园辅助,其实存在有辅助app(哔哩哔哩)1、进入游戏-大厅左侧...
随着!WePOker有没有透视... 随着!WePOker有没有透视方法,花城牌舍辅助系统有哪些功能,一直存在有辅助教程(哔哩哔哩)一、花...
今年以来!wepoker透视功... 今年以来!wepoker透视功能下载,蘑菇辅助网,总是存在有辅助app(哔哩哔哩)1、首先打开蘑菇辅...