spring - swagger 2 spring boot 生成 yml 文件

Question

我是新来的 Swagger ，契约(Contract)，并在我们刚刚开始处理契约(Contract)的 Spring boot (gradle) 项目上工作。我用过 grails，喜欢你如何将字段定义放在域中，并且它通过堆栈继承。

一个具体的问题，也许还有一个小 pig 支持的解释问题。

如何从标准 Controller 类生成 YAML 文件的基本 stub ？

我知道我应该在目录中创建一个 [Name]-v1-0.yml 文件 controller\src\test\resources
我已经在项目中实现了 swagger-ui.html，并且出现了一个非常酷的交互式网页，显示请求端点和东西。使用 class SwaggerConfig extends WebMvcConfigurerAdapter用于在 ui json doc 网页中发布接口(interface)。

我相信理解是测试资源目录中的 yml 文件将是“契约(Contract)”的固定生成，并用于某种 gradle 测试方法以确保 API 签名和契约(Contract)点没有改变，就像一个基本的 junit界面风格测试。 (是/否？)

我在这里懒得想自己，为什么我要手动破解这个愚蠢的文件？
可以从 Controller /模型详细信息中轻松为我生成 yaml 文档骨架吗？

例如在页面上获取一个 YML 文件并执行 ui 友好页面:
http://editor.swagger.io/#/

该页面中有一个非常好的“ super ”示例 YAML 文件，我真的需要写吗，我已经写了 Controller 、javadoc、注释、各种很酷的东西，它们至少应该能够生成一个很好的起始 stub yaml 的，(我怪你 grails 不想破解这个!)那当然是在放置 SpringFox 注释之前，这些注释可以做更多很酷的事情，并且真的要去城里插入更多的测试契约(Contract)保证。

供引用: 'spring-boot-starter-web' 'spring-boot-starter-test' 'springfox-swagger-ui', version: '2.4.0'

Answer 1

我得到了它。很简单，为什么我在任何地方都没有看到这个。 :)

在浏览器中复制/粘贴资源路径:

http://localhost:8095/v2/api-docs?group=full-api

选择生成的内容并复制到剪贴板。

在浏览器中打开 Swagger 编辑器:

http://editor.swagger.io

从文件菜单中选择粘贴 JSON...。

粘贴生成的 Swagger JSON 内容并单击 Import。