Swagger：如何组合来自不同API的共享信息

Question

我正在为现有的java应用程序添加swagger 1.5.0支持，该应用程序实现了20多个不同的REST API，并使用Jersey 1.17.1进行包扫描。有没有人有任何最佳实践建议？例如：

• 应该将swagger定义添加到每个java类中，也可以添加 添加到一个独立的文件，以避免触及每个类？
• 每个API都需要使用@ApiImplicitParam为第一个类详细定义的相同标头集。代替 为每个班级的每个操作重复这些信息，是 有办法将它应用于所有API吗？

Answer 1

有很多种方法可以将swagger 1.5.x库（注意：1.5.10是最新的）与JAX-RS应用程序集成在一起。我建议您按照swagger-petstore中的方案进行操作，并按顶​​级路径段拆分文件，这应该提供一个逻辑组织。

对于重复的标头，您可以让每个资源类扩展一个具有带注释的类级变量的基类。这将适用于扩展它的类中的每个操作。