org.onosproject.rest

Class ApiDocProvider

java.lang.Object

org.onosproject.rest.ApiDocProvider

@Beta
public class ApiDocProvider
extends java.lang.Object

Entity capable of providing REST API documentation resources.

Constructor Summary

Constructors

Constructor and Description
ApiDocProvider(java.lang.String key, java.lang.String name, java.lang.ClassLoader classLoader) Creates a new REST API documentation provider.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	docs() Returns input stream containing Swagger UI compatible JSON.
java.lang.String	key() Returns the REST API key.
java.io.InputStream	model() Returns input stream containing JSON model schema.
java.lang.String	name() Returns the REST API name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocProvider

public ApiDocProvider(java.lang.String key,
                      java.lang.String name,
                      java.lang.ClassLoader classLoader)

Creates a new REST API documentation provider.

Parameters:

key - REST API key

name - REST API name

classLoader - class loader

Method Detail

key

public java.lang.String key()

Returns the REST API key.

Returns:

REST API key

name

public java.lang.String name()

Returns the REST API name.

Returns:

REST API name

docs

public java.io.InputStream docs()

Returns input stream containing Swagger UI compatible JSON.

Returns:

input stream with Swagger JSON data

model

public java.io.InputStream model()

Returns input stream containing JSON model schema.

Returns:

input stream with JSON model schema