首页 文章

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

提问于
浏览
0

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

  • 应该将swagger定义添加到每个java类中,还是可以将它们添加到独立文件中以避免触及每个类?

  • 每个API都需要使用@ApiImplicitParam为第一个类详细定义的相同标头集 . 而不是为每个类的每个操作重复该信息,有没有办法将其应用于所有API?

1 回答

  • 0

    使用JAX-RS应用程序集成swagger 1.5.x库(注意:1.5.10是最新的)有很多方法 . 我建议你遵循swagger-petstore中的方案,并按顶级路径段拆分文件,这应该提供一个逻辑组织 .

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

相关问题