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

Interface ApiDocService

All Known Implementing Classes:

ApiDocServiceImpl

@Path(value="/")
public interface 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.

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	getListOfMounts(javax.ws.rs.core.UriInfo uriInfo) Generates index document for Swagger UI.
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.
javax.ws.rs.core.Response	getMountRootDoc(String instanceNum, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getRootDoc(javax.ws.rs.core.UriInfo uriInfo) Generates index document for Swagger UI.

Method Detail

getRootDoc

@GET
 @Produces(value="application/json")
javax.ws.rs.core.Response getRootDoc(@Context
                                                                               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.

getDocByModule

@GET
 @Path(value="/{module}({revision})")
 @Produces(value="application/json")
javax.ws.rs.core.Response getDocByModule(@PathParam(value="module")
                                                                                                                         String module,
                                                                                                                         @PathParam(value="revision")
                                                                                                                         String revision,
                                                                                                                         @Context
                                                                                                                         javax.ws.rs.core.UriInfo uriInfo)

Generates Swagger compliant document listing APIs for module.

getApiExplorer

@GET
 @Path(value="/ui")
 @Produces(value="text/html")
javax.ws.rs.core.Response getApiExplorer(@Context
                                                                                                javax.ws.rs.core.UriInfo uriInfo)

Redirects to embedded swagger ui.

getListOfMounts

@GET
 @Path(value="/mounts")
 @Produces(value="application/json")
javax.ws.rs.core.Response getListOfMounts(@Context
                                                                                                            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.

getMountRootDoc

@GET
 @Path(value="/mounts/{instance}")
 @Produces(value="application/json")
javax.ws.rs.core.Response getMountRootDoc(@PathParam(value="instance")
                                                                                                                       String instanceNum,
                                                                                                                       @Context
                                                                                                                       javax.ws.rs.core.UriInfo uriInfo)

getMountDocByModule

@GET
 @Path(value="/mounts/{instance}/{module}({revision})")
 @Produces(value="application/json")
javax.ws.rs.core.Response getMountDocByModule(@PathParam(value="instance")
                                                                                                                                                String instanceNum,
                                                                                                                                                @PathParam(value="module")
                                                                                                                                                String module,
                                                                                                                                                @PathParam(value="revision")
                                                                                                                                                String revision,
                                                                                                                                                @Context
                                                                                                                                                javax.ws.rs.core.UriInfo uriInfo)

Generates Swagger compliant document listing APIs for module.