我是 swagger、合约的新手,并且正在从事 Spring boot (gradle) 项目,我们刚刚开始处理合约。我使用过 grails,喜欢如何将字段定义放入域中,并通过堆栈向上继承。
一个具体的问题,也许还有一个小猪支持的平面化问题。
如何从标准控制器类生成 YAML 文件的基本存根?
我知道我应该在目录中创建一个 [Name]-v1-0.yml 文件
controller\src\test\resources
我已经在项目中实现了 swagger-ui.html,并且出现了一个非常酷的交互式网页,显示了请求端点和内容。用一个class SwaggerConfig extends WebMvcConfigurerAdapter
它可以在 ui json doc 网页中发布接口。
我相信的理解是,测试资源目录中的 yml 文件将是“合同”的固定生成,并在某种 gradle 测试方法中使用,以确保 API 签名和合同点没有改变,就像基本的 junit 一样界面风格测试。 (是/否?)
我很懒惰地想,为什么我要手动破解这个愚蠢的文件?
可以很容易地从控制器/模型详细信息生成 yaml 文档框架吗?
例如,在页面上采用 YML 文件并执行 ui 友好页面:http://editor.swagger.io/#/ http://editor.swagger.io/#/
该页面中有一个非常好的“uber”示例 YAML 文件,我真的需要编写它吗?我已经编写了控制器、javadoc、带注释的各种很酷的东西,这些东西应该能够生成至少一个相当好的起始存根yaml 的内容(我责怪你 grails 不想破解这个!)当然,这是在放置 SpringFox 注释之前,它可以做更多很酷的事情,并且真的要去镇上推动更多的测试合同保证。
FYI:
'spring-boot-starter-web'
'spring-boot-starter-test'
'springfox-swagger-ui', version: '2.4.0'