在Spring REST Docs中包含“试用”表单

Question

我开始使用Spring REST Docs，但是我错过了一个强大的功能……“尝试一下！” 按钮，其中包含用于测试API的HTML表单。 我知道卷曲链接； 但我通常使用摇摇欲坠的形式。 Spring REST Docs中有没有简单的方法可以做到这一点？ 谢谢

Answer 1

我通过创建一个将Spring REST Docs cURL代码片段转换为Postman集合的工具自己解决了该问题。 它以npm软件包的形式提供： https ://www.npmjs.com/package/restdocs-to-postman，可在命令行上使用并用作库。 这是https://github.com/spring-projects/spring-restdocs/issues/47的一种解决方案。 我认为像Postman这样的工具可以很好地尝试API。

编辑：有从邮差和失眠到Swagger的转换器。 因此，通过两次转换（将restdocs转换为Postman / Insomnia，将Postman / Insomnia转换为Swagger），可以转换为Swagger游乐场。 这不是最佳方法，但是可以。

转换器示例：

• 邮差到Swagger： https ： //apimatic.io/ （带试用版的付费服务）
• 失眠招摇： https : //github.com/mlabouardy/swaggymnia （MIT许可证）

编辑2：我已经创建了有关如何从Spring REST Docs中创建Swagger操场的说明： https : //github.com/fbenz/restdocs-to-swagger这需要一些步骤，如果直接使用Spring REST Docs，它将更加简单产生Swagger文件，但是它可以工作并且可以自动化。

Answer 2

不，我相信它可以提供最接近的是curl用一个例子请求。 有一个开放的增强功能可提供Postman集合， 网址为https://github.com/spring-projects/spring-restdocs/issues/47 ，但是没有Swagger的try it out!简单try it out!

也与此票证有些相关， https://github.com/spring-projects/spring-restdocs/issues/213 ，

我很想尝试增加对生成Swagger规范的支持。 当您将Swagger描述为提供“ API游乐场”时，您已经做出了非常重要的区分，而其他许多人则没有。 我坚信Swagger的UI不能替代API文档，因此使用它对服务或其用户不利。

我担心的是，如果Spring REST Docs为生成Swagger规范提供了支持，那么人们将使用该规范填充Swagger的UI并考虑将其服务记录在案。 这是权衡信任人们做正确的事情，而不是鼓励人们用脚射击自己的问题。