首先是昂首阔步或api

Question

我已经阅读了swagger的定义和格式，并了解到swagger定义用于描述API。

编写swagger定义然后编写API会更好吗？或者首先编写API然后再招摇？我没有这方面的经验，我想为应用程序编写REST API和swagger文件。

Answer 1

我不认为订单真的很重要。这两种方法在Swagger Getting Started Guide中都具有合法性。关键是应该从另一个生成一个，因此您不必手动维护两者。

在评论中，cricket_007已经提到存在用于从swagger定义生成Web服务框架的工具。使用这些工具，首先编写swagger定义是有意义的。这是入门指南中的Top Down方法。

从上面链接的Swagger入门指南中，您可以看到还有一些工具可用于从Java代码生成Swagger文档，前提是您使用的是JAX-RS等特定框架。这是自下而上的方法。

归结为个人偏好。如果你是那种不想将你的代码库“耦合”到Swagger并确保你的应用程序不依赖于Swagger工作的人，那么自下而上的方法是最好的。但是，如果你想完全接受Swagger工具链并真正“买入”它，那么自上而下的方法可能是最好的。

此外，如果这是出于教育目的，那么请考虑您想要了解的内容。如果您想了解从头开始编写JSON REST API（或使用JAX-RS之类的东西），那么自下而上的方法将教会您更多。但是，如果你的目标是尽可能多地学习Swagger，那么自上而下的方法会更好。