Added queryparam 'ric' for get_types REST API
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / SwaggerConfig.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 Nordix Foundation
6  * %%
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ========================LICENSE_END===================================
19  */
20
21 package org.oransc.policyagent;
22
23 import org.springframework.context.annotation.Bean;
24 import org.springframework.context.annotation.Configuration;
25
26 import springfox.documentation.builders.PathSelectors;
27 import springfox.documentation.builders.RequestHandlerSelectors;
28 import springfox.documentation.spi.DocumentationType;
29 import springfox.documentation.spring.web.plugins.Docket;
30 import springfox.documentation.swagger2.annotations.EnableSwagger2;
31
32 /**
33  * Swagger configuration class that uses swagger2 documentation type and scans all the controllers
34  * under org.oransc.policyagent.controllers package. To access the swagger gui go to
35  * http://ip:port/swagger-ui.html
36  *
37  */
38 @Configuration
39 @EnableSwagger2
40 public class SwaggerConfig {
41     @Bean
42     public Docket api() {
43         return new Docket(DocumentationType.SWAGGER_2).select() //
44             .apis(RequestHandlerSelectors.basePackage("org.oransc.policyagent.controllers")) //
45             .paths(PathSelectors.any()) //
46             .build();
47     }
48 }