NOTE: These API's need to be synchronized due to bug 1198. Thread access to + *
+ * 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 {
+@Component
+@Singleton
+public final class ApiDocServiceImpl implements ApiDocService {
+ // FIXME: make this configurable
+ public static final int DEFAULT_PAGESIZE = 20;
+
+ // Query parameter
+ private static final String PAGE_NUM = "pageNum";
- private static final ApiDocService INSTANCE = new ApiDocServiceImpl();
+ private final MountPointOpenApi mountPointOpenApiRFC8040;
+ private final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040;
- public static ApiDocService getInstance() {
- return INSTANCE;
+ @Inject
+ @Activate
+ public ApiDocServiceImpl(final @Reference DOMSchemaService schemaService,
+ final @Reference DOMMountPointService mountPointService) {
+ this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService),
+ new ApiDocGeneratorRFC8040(schemaService));
}
- /**
- * 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();
- final ResourceList rootDoc = generator.getResourceListing(uriInfo);
+ public ApiDocServiceImpl(final DOMSchemaService schemaService,
+ final DOMMountPointService mountPointService,
+ final String basePath) {
+ this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService, basePath),
+ new ApiDocGeneratorRFC8040(schemaService, basePath));
+ }
- return Response.ok(rootDoc).build();
+ @VisibleForTesting
+ ApiDocServiceImpl(final MountPointOpenApiGeneratorRFC8040 mountPointOpenApiGeneratorRFC8040,
+ final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040) {
+ mountPointOpenApiRFC8040 = requireNonNull(mountPointOpenApiGeneratorRFC8040).getMountPointOpenApi();
+ this.apiDocGeneratorRFC8040 = requireNonNull(apiDocGeneratorRFC8040);
+ }
+
+ @Override
+ public synchronized Response getAllModulesDoc(final UriInfo uriInfo) {
+ final DefinitionNames definitionNames = new DefinitionNames();
+ final OpenApiObject doc = apiDocGeneratorRFC8040.getAllModulesDoc(uriInfo, definitionNames);
+ return Response.ok(doc).build();
}
/**
@@ -57,10 +87,9 @@ public class ApiDocServiceImpl implements ApiDocService {
*/
@Override
public synchronized Response getDocByModule(final String module, final String revision, final UriInfo uriInfo) {
- final ApiDocGenerator generator = ApiDocGenerator.getInstance();
-
- final ApiDeclaration doc = generator.getApiDeclaration(module, revision, uriInfo);
- return Response.ok(doc).build();
+ return Response.ok(
+ apiDocGeneratorRFC8040.getApiDeclaration(module, revision, uriInfo))
+ .build();
}
/**
@@ -68,44 +97,32 @@ public class ApiDocServiceImpl implements ApiDocService {
*/
@Override
public synchronized Response getApiExplorer(final UriInfo uriInfo) {
- return Response
- .seeOther(uriInfo.getBaseUriBuilder().path("../explorer/index.html").build())
- .build();
+ 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