Package org.openhab.core.io.rest.swagger.impl

Class OpenApiResource

java.lang.Object

org.openhab.core.io.rest.swagger.impl.OpenApiResource

All Implemented Interfaces:

RESTResource

@Path("/spec")
@NonNullByDefault
public class OpenApiResource
extends Object
implements RESTResource

An endpoint to generate and provide an OpenAPI description.

Author:

Markus Rathgeb - Initial contribution, Kai Kreuzer - made it a RESTResource to register in the root bean, Yannick Schaus - add support for ReaderListeners, remove dependency, Wouter Born - Migrated to OpenAPI

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_TITLE
static final String	CONTACT_NAME
static final String	CONTACT_URL
static final String	OAUTH_AUTHORIZE_ENDPOINT
static final String	OAUTH_TOKEN_ENDPOINT

Constructor Summary

Constructors

Constructor	Description
OpenApiResource(org.osgi.framework.BundleContext bc, javax.ws.rs.core.Application application)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Object	getOpenAPI()	Gets the current JAX-RS Whiteboard provided endpoint information by OpenAPI.

Methods inherited from class java.lang.Object

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

Field Details

API_TITLE

public static final String API_TITLE

See Also:

• Constant Field Values

CONTACT_NAME

public static final String CONTACT_NAME

See Also:

• Constant Field Values

CONTACT_URL

public static final String CONTACT_URL

See Also:

• Constant Field Values

OAUTH_AUTHORIZE_ENDPOINT

public static final String OAUTH_AUTHORIZE_ENDPOINT

See Also:

• Constant Field Values

OAUTH_TOKEN_ENDPOINT

public static final String OAUTH_TOKEN_ENDPOINT

See Also:

• Constant Field Values

Constructor Details

OpenApiResource

public OpenApiResource(org.osgi.framework.BundleContext bc,
 javax.ws.rs.core.Application application)

Creates a new instance.

Method Details

getOpenAPI

@GET
@Produces("application/json")
public Object getOpenAPI()

Gets the current JAX-RS Whiteboard provided endpoint information by OpenAPI.

Returns:

an OpenAPI description of the endpoints