security - 保护/隐藏Swagger / OpenAPI规范文档是否合适？

第一

安全权衡一切

示例：如果没有风险驱动方法，那么安全是您的第一要务。

如果您信任开发人员并在没有任何审核和两个因素的工作流的情况下授予开发人员访问生产系统的权限，则会遇到安全问题。

第二：

您必须分析您的风险。风险是概率和影响的二维值，如果风险太高，则必须采取措施以降低风险。

示例：有人入侵您的API的可能性有多大？

让我们说，影响为very high，概率为very low。

按照此矩阵，您有中等风险。

如果您的采购订单不愿意承担这种风险，则必须采取一些措施来降低它。

一个想法可能是隐藏API规范，但这只会降低发生这种风险的可能性吗？而且可能性已经非常低。因此，这不再降低风险。

因此，您必须减少影响。好吧，这取决于为什么影响如此之大，对吧？

另一方面：假设您猜想当规范和api为GA时“有人入侵您的api”的可能性为moderate。

然后隐藏该规范可能会稍微降低几率。可能从moderate到low。这样可以将您的风险从High risk降低到Moderate risk。

结论：隐藏api规范是一项可降低某人未经许可访问您的api的可能性的操作。

如果概率已经非常低，则无需隐藏有关安全性问题的api规范。隐藏规范可能还有其他原因。