com.ibm.wsspi.openapi

Interface OASProvider



  • public interface OASProvider
    This interface provides ability to provide OpenAPI Specification documents for a RESTful web services.

    RESTful web services that want to push their OpenAPI Specification documents into the OpenAPI feature, have to implement this interface.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getContextRoot() 
      java.util.List<OASProviderResult> getResults()
      OpenAPI Specification document can be exposed by implementing this method.
      boolean isPublic()
      Specifies whether the provided documents should be included in the public aggregated OpenAPI feature document or not.
    • Method Detail

      • getResults

        java.util.List<OASProviderResult> getResults()
        OpenAPI Specification document can be exposed by implementing this method.
        Returns:
        List of OASProviderResult objects containing OpenAPI Specification documents.
      • getContextRoot

        java.lang.String getContextRoot()
        Returns:
        Context root of the document provider.
      • isPublic

        boolean isPublic()
        Specifies whether the provided documents should be included in the public aggregated OpenAPI feature document or not.
        Returns:
        Specifies if documents should be public or private.