如何禁用 Spring Rest Docs

如何解决如何禁用 Spring Rest Docs

问题 我在我的项目中使用 Spring Rest Docs。它在开发阶段很有用,但我不希望它在生产中可供普通用户搜索引擎使用。

研究 我没有看到包含“nocache”和“noindex”等内容的机器人元标记。实际上预期的可能是一个 spring application.property 字段,如 spring.rest-docs.enabled=false。这样我就可以在生产 spring 配置文件中配置它。

问题如何禁用某些弹簧配置文件的休息文档。

解决方法

有三种方法可以做到:

  • (failed) 使用测试类注释阻止测试(无法将其设置为工作):@IfProfileValue(name = "spring.profiles.active",values = {"prod"})@EnabledIf("${spring.restdocs.enabled}")
  • 失败)配置 maven-resources-plugin 以使用 maven-profiles 和 spring 配置文件(看起来太麻烦):https://stackoverflow.com/a/45817386/1112963
  • (工作) 使用 /resources/static
  • 禁用 application-prod.properties 中的 spring.resources.add-mappings=false 文件夹访问
,

您可以将此属性添加到您的 application.properties

spring.test.restdocs.failOnUndocumentedFields=false
spring.test.restdocs.failOnUndocumentedParams=false

https://scacap.github.io/spring-auto-restdocs/#_configuration

MockMvc 设置期间可用的配置:

failOnUndocumentedParams - 如果构建应该在至少一个未记录的参数上失败 failOnUndocumentedFields - 如果构建应该在至少一个未记录的字段上失败

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


Selenium Web驱动程序和Java。元素在(x,y)点处不可单击。其他元素将获得点击?
Python-如何使用点“。” 访问字典成员?
Java 字符串是不可变的。到底是什么意思?
Java中的“ final”关键字如何工作?(我仍然可以修改对象。)
“loop:”在Java代码中。这是什么,为什么要编译?
java.lang.ClassNotFoundException:sun.jdbc.odbc.JdbcOdbcDriver发生异常。为什么?
这是用Java进行XML解析的最佳库。
Java的PriorityQueue的内置迭代器不会以任何特定顺序遍历数据结构。为什么?
如何在Java中聆听按键时移动图像。
Java“Program to an interface”。这是什么意思?
Java在半透明框架/面板/组件上重新绘画。
Java“ Class.forName()”和“ Class.forName()。newInstance()”之间有什么区别?
在此环境中不提供编译器。也许是在JRE而不是JDK上运行?
Java用相同的方法在一个类中实现两个接口。哪种接口方法被覆盖?
Java 什么是Runtime.getRuntime()。totalMemory()和freeMemory()?
java.library.path中的java.lang.UnsatisfiedLinkError否*****。dll
JavaFX“位置是必需的。” 即使在同一包装中
Java 导入两个具有相同名称的类。怎么处理?
Java 是否应该在HttpServletResponse.getOutputStream()/。getWriter()上调用.close()?
Java RegEx元字符(。)和普通点?