swagger 生产环境关闭,测试环境开放

swaggerUI显示的接口内容主要用于开发阶段便于与前端联调,不适合发布到对外的站点。

有以下两种方式,让接口不显示在SwaggerUI中

1.使用属性 [ApiExplorerSettings(IgnoreApi = true)]设置接口不显示到swaggerUI,此方法比较灵活,可以根据情况在对于的控制器或者API接口中添加。

列如:

    [ApiExplorerSettings(IgnoreApi = true)]
    public class SystemController : ApiController
    {   

    }

这样编写,整个控制器中的接口都不会显示在swaggerUI,如果只是想针对某个接口不显示在UI中,可以在接口处增加属性,列如:

    public class SystemController : ApiController
    {
        [HttpGet]
        [ApiExplorerSettings(IgnoreApi = true)]
        public string GetSystemTime()
        {
            return DateTime.Now.ToString();
        }
}

我们调试一般都会将编译类型选择为Debug,那么可以如下写:

#if (!DEBUG)
    [ApiExplorerSettings(IgnoreApi = true)]
 #endif
public class SystemController : ApiController
{   

}

这样开发阶段就可以正常的查看swaggerUI,到发布到UAT或者其他环境时,选择Release类型编译发布即可。

针对某个接口不显示在UI中,可以在接口处修改属性,列如:

public class SystemController : ApiController
{

        [HttpGet]
        #if (!DEBUG)

            [ApiExplorerSettings(IgnoreApi = true)]

        #endif
        public string GetSystemTime()

        {
            return DateTime.Now.ToString();
        }       
}

第二种方式:

就是不加载SwaggerConfig文件,这样在发布就不会显示swaggerUI,列如:

#if (DEBUG)

    [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

#endif

这样做的缺点是,接口说明都不显示了。

可以通过自己的使用情况,选择合适的方式。

寻寻觅觅转流年,磕磕碰碰道缘浅。 揽几缕、轻挽起,暮暮朝朝与君语。

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值