当前位置: 首页 > 知识库问答 >
问题:

使用Spring REST Docs生成大摇大摆的客户机

沃皓轩
2023-03-14

Spring REST文档是否有可能生成一个像Swagger UI这样的测试UI。

共有1个答案

姬银龙
2023-03-14

这直接违背了Spring REST Docs的设计思想和意图。它的主要目标之一是文档与单元测试相关联,因此即使在REST契约中进行逻辑或签名更改,您也知道文档是坚如磐石的。

此外,正如您链接到的视频所提供的许多示例,说明自动化文档生成如何产生大量不希望的、非预期的输出。

因此,我们可以选择做更多的工作来获得更好的文档,或者做完全自动化的选项来节省时间并获得可行的,但质量较低的文档。这是你的首要任务。

 类似资料:
  • 我有一个java项目(tomcat webapp)和一些REST Api。我想为他们生成大摇大摆的文档。我从本教程(github)开始。我没有maven我们使用蚂蚁任务。我加入了swagger-annotations-1.5.0。jar和所有随swagger jaxrs jar 1.5.0版本附带的jar(如果有用的话,我可以包括一个完整的列表),我已经注释了一些方法,我有一个如下的配置类: }

  • 有没有人用spring-data-rest配置了swagger。我知道swagger有DocumentationConfig类,它扫描所有spring-mvc请求映射。但是,如何将其用于spring-data-rest,因为没有定义显式的请求映射。非常感谢在这方面的任何帮助。此外,我还想知道,是否有其他支持Spring-Data-REST的文档框架。

  • 我想从spring boot 2中切换到Micronaut框架。而我也在为那些大摇大摆的场景而挣扎。 在spring boot 2项目中,我有以下依赖项: 和swaggreconfig.class: 它可以很好地启动swagger-ui和spring boot 2应用程序。 我应该向maven添加哪些依赖项,我应该创建哪些类来为Micronaut项目获得相同的结果?

  • 我当时正在从事spring项目。首先,我将swagger添加到我的项目中,我的swagger用户界面也显示了所有控制器,但当我将JWT承载令牌添加到我的项目中时。不知何故,我无法进入大摇大摆的用户界面。它会一直在我的浏览器中显示以下窗口。我怎样才能解决这个问题有什么想法吗? 在pom中。xml 配置类昂首阔步其他配置类我没有到目前为止 使现代化 遵循代码后

  • 我们在我们的泽西应用程序中使用了@Role允许注释来限制用户对应用编程接口某些部分的访问。我们如何在SwaggerUI中显示这些信息? 到目前为止,我已经用@ApiOperation注释了方法以显示in/out参数,并尝试使用@Authorization/@AuthorizationScope,但我只为我们不使用的oauth2显示了它。最接近out case的是ApiKeyAuthDefiniti

  • 编译得很好,但当我使用BootRun命令启动应用程序时,它失败了,原因是: 会有什么问题?不兼容Java9?那我能让它发挥作用吗?