首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >swagger或api优先

swagger或api优先
EN

Stack Overflow用户
提问于 2016-10-31 21:55:42
回答 1查看 603关注 0票数 2

我已经阅读了swagger的定义和格式,并理解swagger定义是用来描述API的。

先写swagger定义再写API是不是更好?或者先写API,再写swagger?我没有这方面的经验,我想为应用程序编写一个REST API和一个swagger文件。

EN

回答 1

Stack Overflow用户

发布于 2016-10-31 22:21:30

我不认为顺序真的很重要。这两种方法在Swagger Getting Started Guide中都是合法的。关键是一个应该从另一个生成,所以你不需要手动维护这两个。

在评论中,cricket_007已经提到了可以从swagger定义生成web服务框架的工具。使用这些工具,首先编写swagger定义是有意义的。这是入门指南中的自上而下方法。

从上面链接的Swagger入门指南中,您可以看到,如果您使用JAX-RS等特定框架,也可以使用工具从java代码生成Swagger文档。这是自下而上的方法。

归根结底是个人喜好。如果您不愿意将代码库“耦合”到Swagger,并确保您的应用程序不依赖Swagger工作,那么自下而上方法是最好的。但是,如果您想完全接受Swagger工具链并真正“买入”它,那么自顶向下的方法可能是最好的。

此外,如果这是为了教育目的,那么考虑一下你想学习什么。如果您想了解如何从头开始编写JSON REST (或使用JAX-RS之类的东西),那么自下而上方法将教会您更多。但是,如果您的目标是尽可能多地了解Swagger,那么自上而下的方法会更好。

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

https://stackoverflow.com/questions/40343642

复制
相关文章

相似问题

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