从Swagger UI中隐藏安全端点,但将其保留在swagger.json中

35g0bw71  于 2023-08-05  发布在  其他
关注(0)|答案(1)|浏览(124)

我有一些安全的端点,我想隐藏在swagger UI中,但我想把它们保存在swagger.json中,这样客户端生成和其他部分就可以在我的API上实现。

0g0grzrc

0g0grzrc1#

假设你使用的是C#。如果是这种情况,请在要从Swagger UI隐藏的端点上使用**[ApiExplorerSettings(IgnoreApi = true)]**属性。
像往常一样,在startup.cs文件中配置swagger。我想你不需要一个关于如何启用swagger的示例方法。

  • 在Swagger UI中隐藏安全端点。* 在控制器中,对要隐藏的端点应用**[ApiExplorerSettings(IgnoreApi = true)]**属性。

范例

[ApiController]
[Route("api/[controller]")]
public class YourController : ControllerBase
{
    [HttpGet]
    [ApiExplorerSettings(IgnoreApi = true)] // This endpoint will be hidden from Swagger UI
    public IActionResult UnsecureEndpoint()
    {
        // Endpoint logic here
        return Ok("This is an unsecured endpoint.");
    }

    [HttpGet]
    public IActionResult SecureEndpoint()
    {
        // Endpoint logic here
        return Ok("This is a secure endpoint.");
    }
}

字符串

相关问题