Swagger在REST API中识别稀有endpoint

Question

几天前，我在JavaEE 7中启动了一个REST API，我用三个方法实现了一个类，并在项目中成功地实现了Swagger和Swagger-UI，它显示了我在生成的JSON中成功实现的三个endpoint。

但是，我迁移到JavaEE8，在此更改之后，Swagger检测到几个未知endpoint，比如“默认”endpoint（此捕获只显示了其中的一部分）：

通过研究，我发现这些endpoint可能属于Eclipselink实现中的JPA REST API，如https://oracle-base.com/articles/misc/oracle-rest-data-services-ords-open-api-swagger-support和https://www.eclipse.org/Eclipselink/documentation/2.4/solutions/restful_jpa004.htm#chdfcffa所述，尽管它们出现在生成的JSON中，但它们都包含可变路径，所以我无法按照Swagger给出的路径访问它们，甚至无法使用上面示例中的Web发明一些参数，如“version”。

我使用的大摇大摆的版本是v3，也就是OpenAPI版本。我在endpoint类中使用@OpenAPIDefinition指定OpenAPI属性，该类还包含一个@tag批注来对它们进行分组，并且这三个方法包含@operation标记以及它们自己的@APIresponse。不再有我写的大摇大摆/OpenAPI注释/文件/类。

问题是，忽略这些endpoint，我怎么能大摇大摆呢？谢谢

Answer 1

我终于找到了解决办法。情况是，Swagger扫描器引擎扫描整个项目，忽略类和他的方法是否有@operation。如果我的假设是真的，一些Eclipselink类可能有Swagger注释（我不确定），所以当Swagger扫描时，If找到它们并将它们添加到JSON/YAML中。解决方案是创建/添加到现有的openapi.yaml（它可以有多个名称，并且可以位于多个位置，如这里所列举的:https://github.com/swagger-api/swagger-core/wiki/swagger-2.x---integration-and-configuration#known-locations):

resourceClasses:
- com.path.to.your.package.Resource
prettyPrint: true
cacheTTL: 0 
scannerClass: io.swagger.v3.jaxrs2.integration.JaxrsAnnotationScanner
readAllResources: false

可以将其编写为resourceClasses，而不是resourcePackages，然后用与指定包相同的样式指定整个包和类。老实说，这个财产对我的问题没有影响。解决方案是将ReadAllResources设置为False。原因就在这里，在注释中:https://github.com/swagger-api/swagger-core/wiki/swagger-2.x---annotations#operation

Blockquote注意：swagger-jaxrs2阅读器引擎默认情况下还包括未使用@operation注释的已扫描资源的方法，只要在类和/或方法级别定义了jax-rs@path，以及http方法注释(@get、@post等）。

我希望这个解决方案适用于任何人，如果他/她必须面对同样的问题。