org.onosproject.rest.resources

Class ApiDocResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.AbstractInjectionResource

org.onosproject.rest.resources.ApiDocResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="docs")
public class ApiDocResource
extends org.onosproject.rest.AbstractInjectionResource

REST API documentation.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.rest.AbstractInjectionResource

org.onosproject.rest.AbstractInjectionResource.StreamEnumeration

Constructor Summary

Constructors

Constructor and Description
ApiDocResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getApi(String key) Get Swagger UI JSON.
javax.ws.rs.core.Response	getApiList() Get all registered REST API docs.
javax.ws.rs.core.Response	getApiModel(String key) Get REST API model schema.
javax.ws.rs.core.Response	getDefault() Get Swagger UI main index page.
javax.ws.rs.core.Response	getIndex() Get Swagger UI main index page.
javax.ws.rs.core.Response	getResource(String resource) Get Swagger UI resource.

Methods inherited from class org.onosproject.rest.AbstractInjectionResource

split, stream

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Constructor Detail

ApiDocResource

public ApiDocResource()

Method Detail

getApiList

@GET
 @Path(value="apis")
public javax.ws.rs.core.Response getApiList()

Get all registered REST API docs. Returns array of all registered API docs.

Returns:

200 OK

getApi

@GET
 @Path(value="apis/{key: .*?}/swagger.json")
public javax.ws.rs.core.Response getApi(@PathParam(value="key")
                                                                                          String key)

Get Swagger UI JSON.

Parameters:

key - REST API web context

Returns:

200 OK

getApiModel

@GET
 @Path(value="apis/{key: .*?}/model.json")
public javax.ws.rs.core.Response getApiModel(@PathParam(value="name")
                                                                                             String key)

Get REST API model schema.

Parameters:

key - REST API web context

Returns:

200 OK

getDefault

@GET
public javax.ws.rs.core.Response getDefault()
                                          throws IOException,
                                                 URISyntaxException

Get Swagger UI main index page.

Returns:

200 OK

Throws:

IOException - if unable to get index resource

URISyntaxException - if unable to create redirect URI

getIndex

@GET
 @Path(value="index.html")
public javax.ws.rs.core.Response getIndex()
                                                                   throws IOException

Get Swagger UI main index page.

Returns:

200 OK

Throws:

IOException - if unable to get index resource

getResource

@GET
 @Path(value="{resource: .*}")
public javax.ws.rs.core.Response getResource(@PathParam(value="resource")
                                                                                 String resource)
                                                                          throws IOException

Get Swagger UI resource.

Parameters:

resource - path of the resource

Returns:

200 OK

Throws:

IOException - if unable to get named resource