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 Details

  • 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