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

我将swagger 1.5.0支持添加到实现20多个不同REST API的现有Java应用程序中，并将Jersey 1.17.1与包扫描一起使用。有没有人有任何最佳实践建议？例如：Swagger：如何组合来自不同API的共享信息

应该扬鞭定义被添加到每个Java类或者它们可以是加入到一个独立的文件（一个或多个），以避免触及每一类？
每个API都需要使用@ApiImplicitParam为第一个类定义的相同头文件集。而不是重复每个类的每个操作的信息，是有办法将它应用于所有的API？

2016-10-04 user3722575

有许多方法可以将swagger 1.5.x库（注意：1.5.10最新）与JAX-RS应用程序集成在一起。我建议你按照像swagger-petstore这样的方案，并按顶层路径段来分割文件，这应该提供一个合理的组织。

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

2016-10-05 01:23:20 fehguy

谢谢。我浏览了宠物商店的例子。它已经被设计和实施为一个开始使用的招摇的应用程序;我将不得不对我的应用进行大量修改，以模仿该应用已完成的操作。如果有与我的应用程序有关的示例的一部分，我将不胜感激地指出它。第二个响应非常令人兴奋，因为我所有的API类都已经扩展了一个基类。我尝试了一些不同的东西，但无济于事。您可以详细说明如何实现它（例如，在基类中，API类中使用哪些注释...）？ – user3722575

我通过在基类和API类中的特定参数中定义通用参数来实现它。谢谢。 – user3722575

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

回答

相关问题