首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >使用Spring REST文档生成Swagger客户端

问使用Spring REST文档生成Swagger客户端
EN

Stack Overflow用户
提问于 2017-03-15 23:38:19
回答 2查看 866关注 0票数 1

我已经看过这个Spring REST Docs - video

我们正在做Spring boot项目,并使用springfox库来生成Swagger-ui和swagger文档,如here所述

我们喜欢Spring Rest文档可以用来生成REST API文档的功能,并且我们不需要在控制器代码中添加@ApiResponse或@ApiOperation这样的夸张注解。还有一个事实是,文档现在与代码共存。

但是如果使用Spring Rest文档,我们将错过为我们的API自动生成的Swagger-UI (当我们使用swagger集成时)。

Spring REST文档可以生成像Swagger UI这样的测试UI吗?

EN

回答 2

Stack Overflow用户

发布于 2017-04-25 01:50:18

这直接违背了Spring REST Docs的设计理念和意图。它的主要目标之一是将文档绑定到单元测试,这样即使您在REST契约中进行逻辑或签名更改,您的文档也是坚如磐石的。

此外,由于您链接的视频提供了许多示例,说明自动文档生成如何产生许多不必要的意外输出。

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

票数 1
EN

Stack Overflow用户

发布于 2020-02-18 06:20:54

这个项目从Spring REST Docs生成一个OpenAPI规范。

https://github.com/ePages-de/restdocs-api-spec

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/42814347

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档