Generate Swagger using springdoc-openapi OAS 3.0

Link to ADR(Architecture Decision Record) : Swagger using springdoc-openapi

OpenAPI 3.0 related changes

• upgraded to latest springdoc openapi latest version 1.6.14
• used @OpenAPIDefinition annotation to populate OpenAPI Object fields [info, tags, servers, security]
• Documented Search, Info, Health Check API with OpenAPI 3.0 Annotations
• Added the standard HTTP Response(4xx, 5x****x) for API Responses
• Custom Path for
  • Swagger UI: https://host/context-path/swagger (will redirect to https://host/context-path/swagger-ui/index.html)
  • api-docs (JSON) : https://host/context-path/api-docs
  • api-docs (YAML) : https://host/context-path/api-docs.yaml
• Azure Swagger GLAB(for Reference)
  • Swagger UI: https://osdu-glab.msft-osdu-test.org/api/search/v2/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/search/v2/swagger-ui/index.html)
  • api-docs (JSON) : https://osdu-glab.msft-osdu-test.org/api/search/v2/api-docs
  • api-docs (YAML) : https://osdu-glab.msft-osdu-test.org/api/search/v2/api-docs.yaml

Other Changes

• Configurable descriptions managed in swagger.properties
• added Integration Test cases for Swagger api-docs endpoint
• Deleted HomeController
• Hide the WhoamiController
• Updated Readme for swagger related information

References

• https://springdoc.org/faq.html#_can_i_use_spring_property_with_swagger_annotations
• https://springdoc.org/migrating-from-springfox.html

provider/search-azure/src/main/java/org/opengroup/osdu/search/provider/azure/security/AADSecurityConfig.java

@@ -31,6 +31,15 @@ public class AADSecurityConfig extends WebSecurityConfigurerAdapter {
     @Autowired
     private AADAppRoleStatelessAuthenticationFilter appRoleAuthFilter;
 
+    public static final String[] AUTH_ALLOWLIST = {"/", "/index.html",
+            "/api-docs.yaml",
+            "/api-docs/swagger-config",
+            "/api-docs/**",
+            "/swagger",
+            "/swagger-ui.html",
+            "/swagger-ui/**"
+    };
+
     @Override
     protected void configure(HttpSecurity http) throws Exception {
         http
@@ -38,16 +47,7 @@ public class AADSecurityConfig extends WebSecurityConfigurerAdapter {
             .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.NEVER)
             .and()
             .authorizeRequests()
-                .antMatchers("/", "/index.html",
-                        "/v2/api-docs",
-                        "/v3/api-docs",
-                        "/configuration/ui",
-                        "/swagger-resources/**",
-                        "/configuration/security",
-                        "/swagger",
-                        "/swagger-ui.html",
-                        "/swagger-ui/**",
-                        "/webjars/**").permitAll()
+                .antMatchers(AUTH_ALLOWLIST).permitAll()
                 .anyRequest().authenticated()
             .and()
             .addFilterBefore(appRoleAuthFilter, UsernamePasswordAuthenticationFilter.class);