All Known Implementing Classes:

ApiDocServiceImpl
```
@Path("/")
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

All Methods Instance Methods Abstract Methods
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.

Method Detail

getAllModulesDoc

@GET
@Path("/single")
@Produces("application/json")
javax.ws.rs.core.Response getAllModulesDoc(@Context
                                           javax.ws.rs.core.UriInfo uriInfo)

getDocByModule

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

Generates Swagger compliant document listing APIs for module.

getApiExplorer

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

Redirects to embedded swagger ui.

getListOfMounts
```
@GET
@Path("/mounts")
@Produces("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.

getMountDocByModule

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

Generates Swagger compliant document listing APIs for module.

getMountDoc

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

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

Interface ApiDocService