Package com.ibm.wsspi.openapi31
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
Modifier and TypeMethodDescriptiondefault String
OpenAPI Specification document can be exposed by implementing this method.default org.eclipse.microprofile.openapi.models.OpenAPI
OpenAPI Specification model 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 Details
-
getOpenAPIModel
default org.eclipse.microprofile.openapi.models.OpenAPI getOpenAPIModel()OpenAPI Specification model can be exposed by implementing this method.- Returns:
OpenAPI
model constructed through code.
-
getOpenAPIDocument
OpenAPI Specification document can be exposed by implementing this method.- Returns:
- String containing OpenAPI document.
-
getContextRoot
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.
-