/* * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.netconf.sal.rest.doc.impl; import java.io.ByteArrayOutputStream; import java.io.OutputStreamWriter; import java.nio.charset.StandardCharsets; import java.util.Map.Entry; import javax.ws.rs.core.Response; import javax.ws.rs.core.UriInfo; import org.json.JSONWriter; import org.opendaylight.netconf.sal.rest.doc.api.ApiDocService; import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger; import org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration; import org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList; /** * This service generates swagger (See https://helloreverb.com/developers/swagger) compliant documentation for * RESTCONF APIs. The output of this is used by embedded Swagger UI. * *
NOTE: These API's need to be synchronized due to bug 1198. Thread access to
* the SchemaContext is not synchronized properly and thus you can end up with
* missing definitions without this synchronization. There are likely otherways
* to work around this limitation, but given that this API is a dev only tool
* and not dependent UI, this was the fastest work around.
*/
public class ApiDocServiceImpl implements ApiDocService {
private static final ApiDocService INSTANCE = new ApiDocServiceImpl();
public static ApiDocService getInstance() {
return INSTANCE;
}
/**
* Generates index document for Swagger UI. This document lists out all
* modules with link to get APIs for each module. The API for each module is
* served by getDocByModule()
method.
*/
@Override
public synchronized Response getRootDoc(final UriInfo uriInfo) {
final ApiDocGenerator generator = ApiDocGenerator.getInstance();
if (isNew(uriInfo)) {
generator.setDraft(true);
} else {
generator.setDraft(false);
}
final ResourceList rootDoc = generator.getResourceListing(uriInfo);
return Response.ok(rootDoc).build();
}
/**
* Generates Swagger compliant document listing APIs for module.
*/
@Override
public synchronized Response getDocByModule(final String module, final String revision, final UriInfo uriInfo) {
final ApiDocGenerator generator = ApiDocGenerator.getInstance();
if (isNew(uriInfo)) {
generator.setDraft(true);
} else {
generator.setDraft(false);
}
final ApiDeclaration doc = generator.getApiDeclaration(module, revision, uriInfo);
return Response.ok(doc).build();
}
/**
* Redirects to embedded swagger ui.
*/
@Override
public synchronized Response getApiExplorer(final UriInfo uriInfo) {
return Response
.seeOther(uriInfo.getBaseUriBuilder().path("../explorer/index.html").build())
.build();
}
@Override
public synchronized Response getListOfMounts(final UriInfo uriInfo) {
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
try (OutputStreamWriter streamWriter = new OutputStreamWriter(baos, StandardCharsets.UTF_8)) {
final JSONWriter writer = new JSONWriter(streamWriter);
writer.array();
for (final Entry