Class OpenApiResource

  • All Implemented Interfaces:
    RESTResource

    @Path("/spec")
    @NonNullByDefault
    public class OpenApiResource
    extends Object
    implements RESTResource
    An endpoint to generate and provide a 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
    • Constructor Detail

      • OpenApiResource

        public OpenApiResource​(org.osgi.framework.BundleContext bc,
                               javax.ws.rs.core.Application application)
        Creates a new instance.
    • Method Detail

      • getOpenAPI

        @GET
        @Produces("application/json")
        public Object getOpenAPI()
        Gets the current JAX-RS Whiteboard provided endpoint information by OpenAPI.
        Returns:
        a OpenAPI description of the endpoints