io.lighty.swagger

Class ApiDocServiceRFC8040

java.lang.Object

io.lighty.swagger.ApiDocServiceLightyImpl

io.lighty.swagger.ApiDocServiceRFC8040

All Implemented Interfaces:

org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

public class ApiDocServiceRFC8040
extends ApiDocServiceLightyImpl
implements org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

Constructor Summary

Constructors

Constructor and Description
ApiDocServiceRFC8040(org.opendaylight.netconf.sal.rest.doc.impl.MountPointSwaggerGeneratorRFC8040 mountPointSwaggerGeneratorRFC8040, org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040)

Method Summary

Modifier and Type	Method and Description
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	getRootDoc(javax.ws.rs.core.UriInfo uriInfo) Generates index document for Swagger UI.

Methods inherited from class io.lighty.swagger.ApiDocServiceLightyImpl

getListOfMounts, getMountDocByModule, getMountRootDoc

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.netconf.sal.rest.doc.api.ApiDocService

getListOfMounts, getMountDocByModule, getMountRootDoc

Constructor Detail

ApiDocServiceRFC8040

public ApiDocServiceRFC8040(org.opendaylight.netconf.sal.rest.doc.impl.MountPointSwaggerGeneratorRFC8040 mountPointSwaggerGeneratorRFC8040,
                            org.opendaylight.netconf.sal.rest.doc.impl.ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040)

Method Detail

getRootDoc

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

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:

getRootDoc in interface org.opendaylight.netconf.sal.rest.doc.api.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 org.opendaylight.netconf.sal.rest.doc.api.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 org.opendaylight.netconf.sal.rest.doc.api.ApiDocService