restconf/restconf-openapi/src/main/java/org/opendaylight/restconf/openapi/impl/OpenApiServiceImpl.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.openapi.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import java.util.List;
  14 import java.util.stream.Collectors;
  15 import javax.inject.Inject;
  16 import javax.inject.Singleton;
  17 import javax.ws.rs.core.Response;
  18 import javax.ws.rs.core.UriInfo;
  19 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  20 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  21 import org.opendaylight.restconf.openapi.api.OpenApiService;
  22 import org.opendaylight.restconf.openapi.model.MountPointInstance;
  23 import org.opendaylight.restconf.openapi.model.OpenApiObject;
  24 import org.opendaylight.restconf.openapi.mountpoints.MountPointOpenApi;
  25 import org.osgi.service.component.annotations.Activate;
  26 import org.osgi.service.component.annotations.Component;
  27 import org.osgi.service.component.annotations.Reference;
  28
  29
  30 /**
  31  * This service generates swagger (See
  32  * <a href="https://helloreverb.com/developers/swagger"
  33  * >https://helloreverb.com/developers/swagger</a>) compliant documentation for
  34  * RESTCONF APIs. The output of this is used by embedded Swagger UI.
  35  */
  36 @Component
  37 @Singleton
  38 public final class OpenApiServiceImpl implements OpenApiService {
  39     // FIXME: make this configurable
  40     public static final int DEFAULT_PAGESIZE = 20;
  41
  42     // Query parameter
  43     private static final String PAGE_NUM = "pageNum";
  44
  45     private final MountPointOpenApi mountPointOpenApiRFC8040;
  46     private final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040;
  47
  48     @Inject
  49     @Activate
  50     public OpenApiServiceImpl(final @Reference DOMSchemaService schemaService,
  51                              final @Reference DOMMountPointService mountPointService) {
  52         this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService),
  53             new OpenApiGeneratorRFC8040(schemaService));
  54     }
  55
  56     public OpenApiServiceImpl(final DOMSchemaService schemaService,
  57                              final DOMMountPointService mountPointService,
  58                              final String basePath) {
  59         this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService, basePath),
  60             new OpenApiGeneratorRFC8040(schemaService, basePath));
  61     }
  62
  63     @VisibleForTesting
  64     OpenApiServiceImpl(final MountPointOpenApiGeneratorRFC8040 mountPointOpenApiGeneratorRFC8040,
  65                        final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040) {
  66         mountPointOpenApiRFC8040 = requireNonNull(mountPointOpenApiGeneratorRFC8040).getMountPointOpenApi();
  67         this.openApiGeneratorRFC8040 = requireNonNull(openApiGeneratorRFC8040);
  68     }
  69
  70     @Override
  71     public Response getAllModulesDoc(final UriInfo uriInfo) {
  72         final DefinitionNames definitionNames = new DefinitionNames();
  73         final OpenApiObject doc = openApiGeneratorRFC8040.getControllerModulesDoc(uriInfo, definitionNames);
  74         return Response.ok(doc).build();
  75     }
  76
  77     /**
  78      * Generates Swagger compliant document listing APIs for module.
  79      */
  80     @Override
  81     public Response getDocByModule(final String module, final String revision, final UriInfo uriInfo) {
  82         return Response.ok(
  83             openApiGeneratorRFC8040.getApiDeclaration(module, revision, uriInfo))
  84             .build();
  85     }
  86
  87     /**
  88      * Redirects to embedded swagger ui.
  89      */
  90     @Override
  91     public Response getApiExplorer(final UriInfo uriInfo) {
  92         return Response.seeOther(uriInfo.getBaseUriBuilder().path("../explorer/index.html").build()).build();
  93     }
  94
  95     @Override
  96     public Response getListOfMounts(final UriInfo uriInfo) {
  97         final List<MountPointInstance> entity = mountPointOpenApiRFC8040
  98                 .getInstanceIdentifiers().entrySet().stream()
  99                 .map(entry -> new MountPointInstance(entry.getKey(), entry.getValue()))
 100                 .collect(Collectors.toList());
 101         return Response.ok(entity).build();
 102     }
 103
 104     @Override
 105     public Response getMountDocByModule(final String instanceNum, final String module,
 106                                                      final String revision, final UriInfo uriInfo) {
 107         final OpenApiObject api = mountPointOpenApiRFC8040.getMountPointApi(uriInfo, Long.parseLong(instanceNum),
 108             module, revision);
 109         return Response.ok(api).build();
 110     }
 111
 112     @Override
 113     public Response getMountDoc(final String instanceNum, final UriInfo uriInfo) {
 114         final String stringPageNum = uriInfo.getQueryParameters().getFirst(PAGE_NUM);
 115         final OpenApiObject api = mountPointOpenApiRFC8040.getMountPointApi(uriInfo,
 116                 Long.parseLong(instanceNum), stringPageNum);
 117         return Response.ok(api).build();
 118     }
 119 }