Enrichment Coordination Service

[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / SwaggerConfig.java

diff --git a/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java b/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java
new file mode 100644 (file)
index 0000000..07dbefd
--- /dev/null
+++ b/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java
@@ -0,0 +1,95 @@
+/*-
+ * ========================LICENSE_START=================================
+ * O-RAN-SC
+ * %%
+ * Copyright (C) 2019 Nordix Foundation
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================LICENSE_END===================================
+ */
+
+package org.oransc.enrichment;
+
+import com.fasterxml.classmate.TypeResolver;
+import com.google.common.base.Predicates;
+
+import org.oransc.enrichment.controllers.consumer.ConsumerEiJobInfo;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
+
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * Swagger configuration class that uses swagger2 documentation type and scans
+ * all the controllers. To access the swagger gui go to
+ * http://ip:port/swagger-ui.html
+ */
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig extends WebMvcConfigurationSupport {
+
+    static final String API_TITLE = "Enrichment Data service";
+    static final String DESCRIPTION = "This page lists all the rest apis for the service.";
+    static final String VERSION = "1.0";
+    @SuppressWarnings("squid:S1075") // Refactor your code to get this URI from a customizable parameter.
+    static final String RESOURCES_PATH = "classpath:/META-INF/resources/";
+    static final String WEBJARS_PATH = RESOURCES_PATH + "webjars/";
+    static final String SWAGGER_UI = "swagger-ui.html";
+    static final String WEBJARS = "/webjars/**";
+
+    /**
+     * Gets the API info.
+     *
+     * @return the API info.
+     */
+    @Bean
+    public Docket api(TypeResolver resolver) {
+        return new Docket(DocumentationType.SWAGGER_2) //
+            .apiInfo(apiInfo()) //
+            .additionalModels(resolver.resolve(ConsumerEiJobInfo.class)) //
+            .select() //
+            .apis(RequestHandlerSelectors.any()) //
+            .paths(PathSelectors.any()) //
+            .paths(Predicates.not(PathSelectors.regex("/error"))) //
+            // this endpoint is not implemented, but was visible for Swagger
+            .paths(Predicates.not(PathSelectors.regex("/actuator.*"))) //
+            // this endpoint is implemented by spring framework, exclude for now
+            .build();
+    }
+
+    private static ApiInfo apiInfo() {
+        return new ApiInfoBuilder() //
+            .title(API_TITLE) //
+            .description(DESCRIPTION) //
+            .version(VERSION) //
+            .build();
+    }
+
+    @Override
+    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler(SWAGGER_UI) //
+            .addResourceLocations(RESOURCES_PATH);
+
+        registry.addResourceHandler(WEBJARS) //
+            .addResourceLocations(WEBJARS_PATH);
+    }
+
+}