swagger 2 spring boot生成yml文件

Question

我刚开始接受Swagger,合同以及Spring Boot(gradle)项目,我们刚开始处理合同.我已经使用过grails,喜欢你如何在域中放置字段defs,它会通过堆栈继承.

一个特定的问题,也许是一个捎带的splanation问题.

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

我知道我应该在目录中创建一个[Name] -v1-0.yml文件 controller\src\test\resources

我已经在项目中实现了swagger-ui.html,并且出现了一个非常酷的交互式网页,显示了请求端点和内容.使用class SwaggerConfig extends WebMvcConfigurerAdapter它可以在ui json doc网页中发布接口.

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

我懒得在这里思考自己,为什么我要手工攻击这个愚蠢的文件？从控制器/模型细节中可以很容易地为我生成yaml doc骨架吗？

例如,在页面上采用YML文件并执行ui友好页面:http: //editor.swagger.io/#/

在该页面中有一个非常好的"uber"样本YAML文件,我真的需要编写它,我已经编写了Controller,javadoc,带注释,各种很酷的东西应该能够生成至少一个非常好的起始存根yaml,(我责备你的grails因为不想破解这个!)当然之前就是把SpringFox注释做了更多很酷的东西,真正去城里推动更多的测试合同保证.

供参考: '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内容,然后单击"导入".