Package org.opendaylight.netconf.sal.rest.doc.impl

Class ApiDocServiceImpl

java.lang.Object

org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl

All Implemented Interfaces:

ApiDocService

public class ApiDocServiceImpl
extends Object
implements ApiDocService

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApiDocServiceImpl.OAversion
static class	ApiDocServiceImpl.URIType

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PAGESIZE

Constructor Summary

Constructors

Constructor	Description
ApiDocServiceImpl(MountPointSwaggerGeneratorDraft02 mountPointSwaggerGeneratorDraft02, MountPointSwaggerGeneratorRFC8040 mountPointSwaggerGeneratorRFC8040, ApiDocGeneratorDraftO2 apiDocGeneratorDraft02, ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040, AllModulesDocGenerator allModulesDocGenerator)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getAllModulesDoc(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getApiExplorer(javax.ws.rs.core.UriInfo uriInfo)	Redirects to embedded swagger ui.
javax.ws.rs.core.Response	getDocByModule(String module, String revision, javax.ws.rs.core.UriInfo uriInfo)	Generates Swagger compliant document listing APIs for module.
javax.ws.rs.core.Response	getListOfMounts(javax.ws.rs.core.UriInfo uriInfo)	Generates index document for Swagger UI.
javax.ws.rs.core.Response	getMountDoc(String instanceNum, javax.ws.rs.core.UriInfo uriInfo)	Generates Swagger compliant document listing APIs for all modules of mount point.
javax.ws.rs.core.Response	getMountDocByModule(String instanceNum, String module, String revision, javax.ws.rs.core.UriInfo uriInfo)	Generates Swagger compliant document listing APIs for module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PAGESIZE

public static final int DEFAULT_PAGESIZE

See Also:

Constant Field Values

Constructor Detail

ApiDocServiceImpl

public ApiDocServiceImpl(MountPointSwaggerGeneratorDraft02 mountPointSwaggerGeneratorDraft02,
                         MountPointSwaggerGeneratorRFC8040 mountPointSwaggerGeneratorRFC8040,
                         ApiDocGeneratorDraftO2 apiDocGeneratorDraft02,
                         ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040,
                         AllModulesDocGenerator allModulesDocGenerator)

Method Detail

getAllModulesDoc

public javax.ws.rs.core.Response getAllModulesDoc(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getAllModulesDoc in interface ApiDocService

getDocByModule

public javax.ws.rs.core.Response getDocByModule(String module,
                                                String revision,
                                                javax.ws.rs.core.UriInfo uriInfo)

Generates Swagger compliant document listing APIs for module.

Specified by:

getDocByModule in interface ApiDocService

getApiExplorer

public javax.ws.rs.core.Response getApiExplorer(javax.ws.rs.core.UriInfo uriInfo)

Redirects to embedded swagger ui.

Specified by:

getApiExplorer in interface ApiDocService

getListOfMounts

public javax.ws.rs.core.Response getListOfMounts(javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: ApiDocService

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.

Specified by:

getListOfMounts in interface ApiDocService

getMountDocByModule

public javax.ws.rs.core.Response getMountDocByModule(String instanceNum,
                                                     String module,
                                                     String revision,
                                                     javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: ApiDocService

Generates Swagger compliant document listing APIs for module.

Specified by:

getMountDocByModule in interface ApiDocService

getMountDoc

public javax.ws.rs.core.Response getMountDoc(String instanceNum,
                                             javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: ApiDocService

Generates Swagger compliant document listing APIs for all modules of mount point.

Specified by:

getMountDoc in interface ApiDocService