Package 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 Description ApiDocProvider(java.lang.String key, java.lang.String name, java.lang.ClassLoader classLoader)
Creates a new REST API documentation provider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
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
-
-