Quarkus: quarks-openapi filter packages to scan for documenting. and support swagger annotations

[mostafacs]

Package to scan
It would be nice to have a feature to choose specific packages to be documenting and handling by openapi and swagger.
Because I was to document only public endpoints (generate HTML docs and swagger docs) and keep internal endpoints secret.
Support swagger annotations
I want to document endpoints and model class using annotations like @ApiModel, @Api,...
or the v3 swagger annotations like @Schema,...

Thanks.

[quarkusbot]

/cc @EricWittmann, @MikeEdgar, @phillip-kruger

[MikeEdgar]

@mostafacs - have you tried the MicroProfile OpenAPI configuration properties?

https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.adoc#311-core-configurations

Specifically:

• mp.openapi.scan.packages
• mp.openapi.scan.classes
• mp.openapi.scan.exclude.packages
• mp.openapi.scan.exclude.classes

[mostafacs]

@MikeEdgar Thanks. I will try it now. What about swagger annotations for documenting endpoints and models ?

[MikeEdgar]

@mostafacs , MicroProfile OpenAPI also has a set of annotations, listed on that same spec page: https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.adoc#documentation-mechanisms

JAX-RS endpoints should automatically be scanned since they are annotated with @Path (unless excluded with one of the previously-mentioned properties).

[mostafacs]

Got it. thanks so much.